@centrali-io/centrali-sdk 1.8.7

package/dist/index.js

@@ -0,0 +1,211 @@
+"use strict";
+/*
+ * Centrali TypeScript SDK
+ * ----------------------
+ * A lightweight SDK for interacting with Centrali's Data and Compute APIs,
+ * with support for user-provided tokens or client credentials (Client ID/Secret).
+ */
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CentraliSDK = void 0;
+exports.getAuthUrl = getAuthUrl;
+exports.fetchClientToken = fetchClientToken;
+exports.getRecordApiPath = getRecordApiPath;
+exports.getFileUploadApiPath = getFileUploadApiPath;
+exports.getComputeFunctionTriggerApiPath = getComputeFunctionTriggerApiPath;
+const axios_1 = __importDefault(require("axios"));
+const qs_1 = __importDefault(require("qs"));
+// Helper to encode form data
+function encodeFormData(data) {
+    return new URLSearchParams(data).toString();
+}
+/**
+ * Generate the auth server URL from the API base URL.
+ */
+function getAuthUrl(apiBaseUrl) {
+    const url = new URL(apiBaseUrl);
+    // assume auth is hosted at auth.<api-domain>
+    return `${url.protocol}//auth.${url.hostname}`;
+}
+/**
+ * Retrieve an access token using the Client Credentials flow.
+ */
+function fetchClientToken(clientId, clientSecret, apiBaseUrl) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const authUrl = getAuthUrl(apiBaseUrl);
+        const tokenEndpoint = `${authUrl}/token`;
+        const form = encodeFormData({
+            grant_type: 'client_credentials',
+            client_id: clientId,
+            client_secret: clientSecret,
+            resource: `${apiBaseUrl}/data`
+        });
+        const resp = yield axios_1.default.post(tokenEndpoint, form, { headers: { 'Content-Type': 'application/x-www-form-urlencoded' },
+            proxy: false
+        });
+        return resp.data.access_token;
+    });
+}
+/**
+ * Generate Records API URL PATH.
+ */
+function getRecordApiPath(workspaceId, recordSlug, id) {
+    return id ? `data/workspace/${workspaceId}/api/v1/records/slug/${recordSlug}/${id}` : `data/workspace/${workspaceId}/api/v1/records/slug/${recordSlug}`;
+}
+/**
+ * Generate File Upload API URL PATH.
+ * @param workspaceId
+ */
+function getFileUploadApiPath(workspaceId) {
+    return `storage/ws/${workspaceId}/api/v1/files`;
+}
+/*
+* Generate Compute Function Trigger API URL PATH.
+ */
+function getComputeFunctionTriggerApiPath(workspaceId, functionId) {
+    return `data/workspace/${workspaceId}/api/v1/function-triggers/${functionId}/execute`;
+}
+/**
+ * Main Centrali SDK client.
+ */
+class CentraliSDK {
+    constructor(options) {
+        this.token = null;
+        this.options = options;
+        this.token = options.token || null;
+        this.axios = axios_1.default.create(Object.assign({ baseURL: options.baseUrl, paramsSerializer: (params) => qs_1.default.stringify(params, { arrayFormat: "repeat" }), proxy: false }, options.axiosConfig));
+        // Attach async interceptor to fetch token on first request if needed
+        this.axios.interceptors.request.use((config) => __awaiter(this, void 0, void 0, function* () {
+            if (!this.token && this.options.clientId && this.options.clientSecret) {
+                this.token = yield fetchClientToken(this.options.clientId, this.options.clientSecret, this.options.baseUrl);
+            }
+            if (this.token) {
+                config.headers.Authorization = `Bearer ${this.token}`;
+            }
+            return config;
+        }), (error) => Promise.reject(error));
+    }
+    /**
+     * Manually set or update the bearer token for subsequent requests.
+     */
+    setToken(token) {
+        this.token = token;
+    }
+    /**
+     * Fetch Service Account token using Client Credentials flow.
+     */
+    fetchServiceAccountToken() {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (!this.options.clientId || !this.options.clientSecret) {
+                throw new Error('Client ID and Client Secret are required to fetch Service Account token.');
+            }
+            const token = yield fetchClientToken(this.options.clientId, this.options.clientSecret, this.options.baseUrl);
+            return token;
+        });
+    }
+    /**
+     * Perform an HTTP request.
+     */
+    request(method, path, data, queryParams, config) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const resp = yield this.axios.request(Object.assign({ method, url: path, data, params: queryParams }, config));
+            // 🔧 Normalize non-object responses
+            if (typeof resp.data !== 'object') {
+                return { data: resp.data };
+            }
+            return resp.data;
+        });
+    }
+    // ------------------ Data API Methods ------------------
+    /** Create a new record in a given recordSlug. */
+    createRecord(recordSlug, record) {
+        const path = getRecordApiPath(this.options.workspaceId, recordSlug);
+        return this.request('POST', path, Object.assign({}, record));
+    }
+    /** Get the token used for authentication. */
+    getToken() {
+        return this.token;
+    }
+    /** Retrieve a record by ID. */
+    getRecord(recordSlug, id) {
+        const path = getRecordApiPath(this.options.workspaceId, recordSlug, id);
+        return this.request('GET', path);
+    }
+    /** Query records with filters, pagination, etc. */
+    queryRecords(recordSlug, queryParams) {
+        const path = getRecordApiPath(this.options.workspaceId, recordSlug);
+        return this.request('GET', path, null, Object.assign({}, queryParams));
+    }
+    /** Get records by Ids. */
+    getRecordsByIds(recordSlug, ids) {
+        const path = getRecordApiPath(this.options.workspaceId, recordSlug) + '/bulk/get';
+        return this.request('POST', path, { ids });
+    }
+    /** Update an existing record by ID. */
+    updateRecord(recordSlug, id, updates) {
+        const path = getRecordApiPath(this.options.workspaceId, recordSlug, id);
+        return this.request('PUT', path, Object.assign({}, updates));
+    }
+    /** Delete a record by ID. */
+    deleteRecord(recordSlug, id) {
+        const path = getRecordApiPath(this.options.workspaceId, recordSlug, id);
+        return this.request('DELETE', path);
+    }
+    // ------------------ Compute API Methods ------------------
+    /** Invoke a compute function by name with given payload. */
+    invokeFunction(functionId, payload) {
+        const path = getComputeFunctionTriggerApiPath(this.options.workspaceId, functionId);
+        return this.request('POST', path, { data: payload });
+    }
+    // ------------------ Storage API Methods ------------------
+    /** Upload a file to the storage service. */
+    uploadFile(file_1, location_1) {
+        return __awaiter(this, arguments, void 0, function* (file, location, isPublic = false) {
+            const path = getFileUploadApiPath(this.options.workspaceId);
+            const formData = new FormData();
+            const fileName = this.options.workspaceId + Date.now() + file.name;
+            formData.append('file', file);
+            formData.append('location', location);
+            formData.append('fileName', fileName);
+            formData.append('isPublic', isPublic ? 'true' : 'false');
+            return this.request('POST', path, formData, undefined, {
+                headers: {
+                    'Content-Type': 'multipart/form-data',
+                },
+            });
+        });
+    }
+}
+exports.CentraliSDK = CentraliSDK;
+/**
+ * Usage Example:
+ *
+ * ```ts
+ * import { CentraliSDK, CentraliSDKOptions } from 'centrali-sdk';
+ *
+ * const options: CentraliSDKOptions = {
+ *   baseUrl: 'https://api.centrali.com',
+ *   clientId: process.env.CLIENT_ID,
+ *   clientSecret: process.env.CLIENT_SECRET,
+ * };
+ * const client = new CentraliSDK(options);
+ *
+ * // Automatic client credentials flow on first request
+ * const record = await client.createRecord('Customer', { email: 'jane@example.com' });
+ *
+ * // Or set a user token:
+ * client.setToken('<JWT_TOKEN>');
+ * await client.queryRecords('Product', { limit: 10 });
+ *```
+ */

package/index.ts

@@ -0,0 +1,315 @@
+/*
+ * Centrali TypeScript SDK
+ * ----------------------
+ * A lightweight SDK for interacting with Centrali's Data and Compute APIs,
+ * with support for user-provided tokens or client credentials (Client ID/Secret).
+ */
+
+import axios, {AxiosInstance, AxiosRequestConfig, AxiosRequestHeaders, AxiosResponse, Method} from 'axios';
+import qs from 'qs';
+// Helper to encode form data
+function encodeFormData(data: Record<string, string>): string {
+    return new URLSearchParams(data).toString();
+}
+
+/**
+ * Options for initializing the Centrali SDK client.
+ */
+export interface CentraliSDKOptions {
+    /** Base URL of the Centrali API (e.g. https://api.centrali.com) */
+    baseUrl: string;
+    workspaceId: string;
+    /** Optional initial bearer token for authentication */
+    token?: string;
+    /** Optional OAuth2 client credentials */
+    clientId?: string;
+    clientSecret?: string;
+    /** Optional custom axios config */
+    axiosConfig?: AxiosRequestConfig;
+}
+
+/**
+ * Generic API response wrapper.
+ */
+export interface ApiResponse<T> {
+    data: T;
+    meta?: Record<string, any>;
+    error?: any
+    id?: string;
+    createdAt?: string;
+    updatedAt?: string;
+}
+
+
+
+/**
+ * Generate the auth server URL from the API base URL.
+ */
+export function getAuthUrl(apiBaseUrl: string): string {
+    const url = new URL(apiBaseUrl);
+    // assume auth is hosted at auth.<api-domain>
+    return `${url.protocol}//auth.${url.hostname}`;
+}
+
+/**
+ * Retrieve an access token using the Client Credentials flow.
+ */
+export async function fetchClientToken(
+    clientId: string,
+    clientSecret: string,
+    apiBaseUrl: string
+): Promise<string> {
+    const authUrl = getAuthUrl(apiBaseUrl);
+    const tokenEndpoint = `${authUrl}/token`;
+    const form = encodeFormData({
+        grant_type: 'client_credentials',
+        client_id: clientId,
+        client_secret: clientSecret,
+        resource: `${apiBaseUrl}/data`
+    });
+    const resp = await axios.post(
+        tokenEndpoint,
+        form,
+        { headers: { 'Content-Type': 'application/x-www-form-urlencoded' },
+          proxy: false
+        }
+    );
+
+    return resp.data.access_token;
+}
+
+/**
+ * Generate Records API URL PATH.
+ */
+
+export function getRecordApiPath(workspaceId: string,recordSlug: string, id?: string): string {
+    return id ? `data/workspace/${workspaceId}/api/v1/records/slug/${recordSlug}/${id}` : `data/workspace/${workspaceId}/api/v1/records/slug/${recordSlug}`;
+}
+
+
+/**
+ * Generate File Upload API URL PATH.
+ * @param workspaceId
+ */
+export function getFileUploadApiPath(workspaceId: string): string {
+    return `storage/ws/${workspaceId}/api/v1/files`;
+}
+
+/*
+* Generate Compute Function Trigger API URL PATH.
+ */
+export function getComputeFunctionTriggerApiPath(workspaceId: string, functionId: string): string {
+    return `data/workspace/${workspaceId}/api/v1/function-triggers/${functionId}/execute`;
+}
+
+/**
+ * Main Centrali SDK client.
+ */
+export class CentraliSDK {
+    private axios: AxiosInstance;
+    private token: string | null = null;
+    private options: CentraliSDKOptions;
+
+    constructor(options: CentraliSDKOptions) {
+        this.options = options;
+        this.token = options.token || null;
+        this.axios = axios.create({
+            baseURL: options.baseUrl,
+            paramsSerializer: (params: Record<string, any>): string =>
+                    qs.stringify(params, { arrayFormat: "repeat" }),
+            proxy: false,
+            ...options.axiosConfig,
+        });
+
+        // Attach async interceptor to fetch token on first request if needed
+        this.axios.interceptors.request.use(
+            async (config) => {
+                if (!this.token && this.options.clientId && this.options.clientSecret) {
+                    this.token = await fetchClientToken(
+                        this.options.clientId,
+                        this.options.clientSecret,
+                        this.options.baseUrl
+                    );
+                }
+                if (this.token) {
+                    config.headers.Authorization = `Bearer ${this.token}`;
+                }
+                return config;
+            },
+            (error) => Promise.reject(error)
+        );
+    }
+
+    /**
+     * Manually set or update the bearer token for subsequent requests.
+     */
+    public setToken(token: string): void {
+        this.token = token;
+    }
+
+    /**
+     * Fetch Service Account token using Client Credentials flow.
+     */
+    public async fetchServiceAccountToken(): Promise<string> {
+        if (!this.options.clientId || !this.options.clientSecret) {
+            throw new Error('Client ID and Client Secret are required to fetch Service Account token.');
+        }
+       const token = await fetchClientToken(
+            this.options.clientId,
+            this.options.clientSecret,
+            this.options.baseUrl
+        );
+        return token;
+    }
+
+    /**
+     * Perform an HTTP request.
+     */
+    private async request<T>(
+        method: Method,
+        path: string,
+        data?: any,
+        queryParams?: Record<string, any>,
+        config?: AxiosRequestConfig
+    ): Promise<ApiResponse<T>> {
+        const resp = await this.axios.request<ApiResponse<T>>({
+            method,
+            url: path,
+            data,
+            params: queryParams,
+            ...config,
+        });
+
+        // 🔧 Normalize non-object responses
+        if (typeof resp.data !== 'object') {
+            return { data: resp.data as T };
+        }
+        return resp.data;
+    }
+
+    // ------------------ Data API Methods ------------------
+
+    /** Create a new record in a given recordSlug. */
+    public createRecord<T = any>(
+        recordSlug: string,
+        record: Record<string, any>
+    ): Promise<ApiResponse<T>> {
+        const path = getRecordApiPath(this.options.workspaceId, recordSlug);
+        return this.request('POST', path, {  ...record });
+    }
+
+    /** Get the token used for authentication. */
+    public getToken(): string | null {
+        return this.token;
+    }
+
+
+    /** Retrieve a record by ID. */
+    public getRecord<T = any>(
+        recordSlug: string,
+        id: string
+    ): Promise<ApiResponse<T>> {
+        const path = getRecordApiPath(this.options.workspaceId, recordSlug, id);
+        return this.request('GET', path);
+    }
+
+    /** Query records with filters, pagination, etc. */
+    public queryRecords<T = any>(
+        recordSlug: string,
+        queryParams: Record<string, any>
+    ): Promise<ApiResponse<T>> {
+        const path = getRecordApiPath(this.options.workspaceId, recordSlug);
+        return this.request('GET', path, null, {
+            ...queryParams,
+        });
+    }
+
+    /** Get records by Ids. */
+    public getRecordsByIds<T = any>(
+        recordSlug: string,
+        ids: string[]
+    ): Promise<ApiResponse<T[]>> {
+        const path = getRecordApiPath(this.options.workspaceId, recordSlug) + '/bulk/get';
+        return this.request('POST', path, { ids });
+    }
+
+    /** Update an existing record by ID. */
+    public updateRecord<T = any>(
+        recordSlug: string,
+        id: string,
+        updates: Record<string, any>
+    ): Promise<ApiResponse<T>> {
+        const path = getRecordApiPath(this.options.workspaceId, recordSlug, id);
+        return this.request('PUT', path, {  ...updates });
+    }
+
+    /** Delete a record by ID. */
+    public deleteRecord(
+        recordSlug: string,
+        id: string
+    ): Promise<ApiResponse<null>> {
+        const path = getRecordApiPath(this.options.workspaceId, recordSlug, id);
+        return this.request('DELETE', path);
+    }
+
+    // ------------------ Compute API Methods ------------------
+
+    /** Invoke a compute function by name with given payload. */
+    public invokeFunction<T = any>(
+        functionId: string,
+        payload: Record<string, any>
+    ): Promise<ApiResponse<T>> {
+        const path = getComputeFunctionTriggerApiPath(this.options.workspaceId, functionId);
+        return this.request('POST', path, { data: payload });
+    }
+
+
+
+
+    // ------------------ Storage API Methods ------------------
+
+    /** Upload a file to the storage service. */
+    public async uploadFile(
+        file: File,
+        location: string,
+        isPublic: boolean = false
+    ): Promise<ApiResponse<string>> {
+        const path = getFileUploadApiPath(this.options.workspaceId);
+        const formData = new FormData();
+        const fileName = this.options.workspaceId + Date.now() + file.name;
+
+        formData.append('file', file);
+        formData.append('location', location);
+        formData.append('fileName', fileName);
+        formData.append('isPublic', isPublic ? 'true' : 'false');
+
+        return this.request<string>('POST', path, formData, undefined, {
+            headers: {
+                'Content-Type': 'multipart/form-data',
+            },
+        });
+    }
+
+}
+
+/**
+ * Usage Example:
+ *
+ * ```ts
+ * import { CentraliSDK, CentraliSDKOptions } from 'centrali-sdk';
+ *
+ * const options: CentraliSDKOptions = {
+ *   baseUrl: 'https://api.centrali.com',
+ *   clientId: process.env.CLIENT_ID,
+ *   clientSecret: process.env.CLIENT_SECRET,
+ * };
+ * const client = new CentraliSDK(options);
+ *
+ * // Automatic client credentials flow on first request
+ * const record = await client.createRecord('Customer', { email: 'jane@example.com' });
+ *
+ * // Or set a user token:
+ * client.setToken('<JWT_TOKEN>');
+ * await client.queryRecords('Product', { limit: 10 });
+ *```
+ */

package/package.json

@@ -0,0 +1,32 @@
+{
+  "name": "@centrali-io/centrali-sdk",
+  "version": "1.8.7",
+  "description": "Centrali Node SDK",
+  "main": "dist/index.js",
+  "type": "commonjs",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/blueinit/centrali-sdk.git"
+  },
+  "scripts": {
+    "build": "tsc --project tsconfig.json",
+    "prepublishOnly": "npm run build",
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "keywords": [],
+  "author": "Blueinit",
+  "license": "ISC",
+  "dependencies": {
+    "axios": "^1.12.0",
+    "qs": "^6.14.0"
+  },
+  "devDependencies": {
+    "@types/q": "^1.5.8",
+    "@types/qs": "^6.14.0",
+    "typescript": "^5.8.3"
+  },
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org/",
+    "access": "public"
+  }
+}

package/tsconfig.json

@@ -0,0 +1,113 @@
+{
+  "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. */
+    // "libReplacement": true,                           /* Enable lib replacement. */
+    // "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": "./dist",                                   /* 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. */
+    // "erasableSyntaxOnly": true,                       /* Do not allow runtime constructs that are not part of ECMAScript. */
+    // "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 */
+    // "skipDefaultLibCheck": true,                      /* Skip type checking .d.ts files that are included with TypeScript. */
+    "skipLibCheck": true                                 /* Skip type checking all .d.ts files. */
+  }
+}