hive-intelligence 0.1.0

package/.env,example

@@ -0,0 +1 @@
+HIVE_API_KEY=

package/README.md

@@ -0,0 +1,77 @@
+# 🧠 Hive Intelligence TypeScript SDK
+
+The Hive Intelligence SDK lets you integrate real-time crypto and Web3 intelligence into your JavaScript or TypeScript apps using simple prompt or chat-style inputs.
+
+## 🚀 Installation
+
+Using npm:
+
+```bash
+npm install hive-intelligence
+```
+
+Or using yarn:
+
+```bash
+yarn add hive-intelligence
+```
+
+## 🔑 Setup
+Set your Hive API key as an environment variable:
+
+```bash
+export HIVE_API_KEY=your_api_key_here
+```
+
+## 🧪 Example Usage
+
+```ts
+import { HiveSearchClient } from 'hive-intelligence';
+import { HiveSearchRequest, HiveSearchMessage, HiveSearchResponse} from 'hive-intelligence/types';
+
+// Get API key from env
+const apiKey = process.env.HIVE_API_KEY;
+if (!apiKey) {
+  throw new Error('Please set the HIVE_API_KEY environment variable');
+}
+
+// Initialize client
+const client = new HiveSearchClient(apiKey);
+
+// 🟡 Example 1: Prompt-based query
+const promptRequest: HiveSearchRequest = {
+  prompt: 'What is the current price of Ethereum?'
+};
+
+client.search(promptRequest).then((response: HiveSearchResponse) => {
+  console.log('Prompt Response:', response);
+}).catch(console.error);
+
+// 🟢 Example 2: Chat-style query
+const chatRequest: HiveSearchRequest = {
+  messages: [
+    { role: 'user', content: 'Price of' },
+    { role: 'assistant', content: 'Price of what?' },
+    { role: 'user', content: 'BTC' }
+  ]
+};
+
+client.search(chatRequest).then((response: HiveSearchResponse) => {
+  console.log('Chat Response:', response);
+}).catch(console.error);
+```
+
+## 📘 Request Options
+* `prompt`: Plaintext question or query
+* `messages`: Array of `{ role, content }` for chat
+* Optional parameters:
+   * `temperature`: (e.g. 0.7) randomness of response
+   * `top_k`: max tokens considered
+   * `top_p`: nucleus sampling
+   * `include_data_sources`: show source info
+
+## ❗ Error Handling
+On error, the SDK throws `HiveSearchAPIError` with:
+* `status`: HTTP status code
+* `statusText`: status message
+* `body`: full API response

package/dist/client.d.ts

@@ -0,0 +1,7 @@
+import { HiveSearchRequest, HiveSearchResponse } from './types';
+export declare class HiveSearchClient {
+    private readonly apiKey;
+    private readonly baseUrl;
+    constructor(apiKey: string);
+    search(params: HiveSearchRequest): Promise<HiveSearchResponse>;
+}

package/dist/client.js

@@ -0,0 +1,52 @@
+"use strict";
+// src/client.ts
+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.HiveSearchClient = void 0;
+const axios_1 = __importDefault(require("axios"));
+const errors_1 = require("./errors");
+class HiveSearchClient {
+    constructor(apiKey) {
+        this.baseUrl = 'https://api.hiveintelligence.xyz/v1/search';
+        this.apiKey = apiKey;
+    }
+    search(params) {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                const response = yield axios_1.default.post(this.baseUrl, params, {
+                    headers: {
+                        Authorization: `Bearer ${this.apiKey}`,
+                        'Content-Type': 'application/json',
+                    },
+                });
+                return response.data;
+            }
+            catch (error) {
+                if (error.response) {
+                    // Extracting error details from the API response
+                    const errorMessage = error.response.data.error || error.response.data.message || 'Unknown error';
+                    // Throwing the custom error with the extracted message
+                    throw new errors_1.HiveSearchAPIError(error.response.status, error.response.statusText, error.response.data, // Body of the response
+                    errorMessage // Message from the response
+                    );
+                }
+                else {
+                    // If no response was received, throw a general error
+                    throw new Error('Unknown error occurred while calling HiveSearch API');
+                }
+            }
+        });
+    }
+}
+exports.HiveSearchClient = HiveSearchClient;

package/dist/errors.d.ts

@@ -0,0 +1,7 @@
+export declare class HiveSearchAPIError extends Error {
+    status: number;
+    statusText: string;
+    body: any;
+    message: string;
+    constructor(status: number, statusText: string, body: any, message: string);
+}

package/dist/errors.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HiveSearchAPIError = void 0;
+class HiveSearchAPIError extends Error {
+    constructor(status, statusText, body, message // Add message to hold the specific error details
+    ) {
+        super(`HiveSearch API Error: ${status} ${statusText} - ${message}`);
+        this.status = status;
+        this.statusText = statusText;
+        this.body = body;
+        this.message = message;
+        this.name = 'HiveSearchAPIError';
+    }
+}
+exports.HiveSearchAPIError = HiveSearchAPIError;

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./client";
+export * from "./types";
+export * from "./errors";

package/dist/index.js

@@ -0,0 +1,20 @@
+"use strict";
+// src/index.ts
+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("./client"), exports);
+__exportStar(require("./types"), exports);
+__exportStar(require("./errors"), exports);

package/dist/types.d.ts

@@ -0,0 +1,19 @@
+export interface HiveSearchMessage {
+    role: 'user' | 'assistant';
+    content: string;
+}
+export interface HiveSearchRequest {
+    prompt?: string;
+    messages?: HiveSearchMessage[];
+    temperature?: number;
+    top_k?: number;
+    top_p?: number;
+    include_data_sources?: boolean;
+}
+export interface HiveSearchResponse {
+    response: {
+        [key: string]: any;
+    };
+    isAdditionalDataRequired: [] | null;
+    data_sources?: string[];
+}

package/dist/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/example.ts

@@ -0,0 +1,35 @@
+import { HiveSearchClient } from './dist/client'
+import { HiveSearchRequest, HiveSearchMessage, HiveSearchResponse } from './dist/types'
+import { config } from 'dotenv';
+config();
+
+// Get API key from env
+const apiKey = process.env.HIVE_API_KEY;
+if (!apiKey) {
+  throw new Error('Please set the HIVE_API_KEY environment variable');
+}
+
+// Initialize client
+const client = new HiveSearchClient(apiKey);
+
+// 🟡 Example 1: Prompt-based query
+const promptRequest: HiveSearchRequest = {
+  prompt: 'What is the current price of Ethereum?'
+};
+
+client.search(promptRequest).then((response: HiveSearchResponse) => {
+  console.log('Prompt Response:', response);
+}).catch(console.error);
+
+// 🟢 Example 2: Chat-style query
+const chatRequest: HiveSearchRequest = {
+  messages: [
+    { role: 'user', content: 'Price of' },
+    { role: 'assistant', content: 'Price of what?' },
+    { role: 'user', content: 'BTC' }
+  ]
+};
+
+client.search(chatRequest).then((response: HiveSearchResponse) => {
+  console.log('Chat Response:', response);
+}).catch(console.error);

package/jest.config.js

@@ -0,0 +1,7 @@
+/** @type {import('ts-jest').JestConfigWithTsJest} **/
+module.exports = {
+  testEnvironment: "node",
+  transform: {
+    "^.+\.tsx?$": ["ts-jest",{}],
+  },
+};

package/package.json

@@ -0,0 +1,23 @@
+{
+  "name": "hive-intelligence",
+  "version": "0.1.0",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "build": "tsc",
+    "test": "jest"
+  },
+  "keywords": [],
+  "author": "",
+  "description": "",
+  "dependencies": {
+    "axios": "^1.8.4",
+    "dotenv": "^16.5.0"
+  },
+  "devDependencies": {
+    "@types/jest": "^29.5.14",
+    "jest": "^29.7.0",
+    "ts-jest": "^29.3.1",
+    "typescript": "^5.8.3"
+  }
+}

package/src/client.js

@@ -0,0 +1,52 @@
+"use strict";
+// src/client.ts
+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.HiveSearchClient = void 0;
+const axios_1 = __importDefault(require("axios"));
+const errors_1 = require("./errors");
+class HiveSearchClient {
+    constructor(apiKey) {
+        this.baseUrl = 'https://api.hiveintelligence.xyz/v1/search';
+        this.apiKey = apiKey;
+    }
+    search(params) {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                const response = yield axios_1.default.post(this.baseUrl, params, {
+                    headers: {
+                        Authorization: `Bearer ${this.apiKey}`,
+                        'Content-Type': 'application/json',
+                    },
+                });
+                return response.data;
+            }
+            catch (error) {
+                if (error.response) {
+                    // Extracting error details from the API response
+                    const errorMessage = error.response.data.error || error.response.data.message || 'Unknown error';
+                    // Throwing the custom error with the extracted message
+                    throw new errors_1.HiveSearchAPIError(error.response.status, error.response.statusText, error.response.data, // Body of the response
+                    errorMessage // Message from the response
+                    );
+                }
+                else {
+                    // If no response was received, throw a general error
+                    throw new Error('Unknown error occurred while calling HiveSearch API');
+                }
+            }
+        });
+    }
+}
+exports.HiveSearchClient = HiveSearchClient;

package/src/client.ts

@@ -0,0 +1,42 @@
+// src/client.ts
+
+import axios from 'axios';
+import { HiveSearchRequest, HiveSearchResponse } from './types';
+import { HiveSearchAPIError } from './errors';
+
+export class HiveSearchClient {
+  private readonly apiKey: string;
+  private readonly baseUrl: string = 'https://api.hiveintelligence.xyz/v1/search';
+
+  constructor(apiKey: string) {
+    this.apiKey = apiKey;
+  }
+
+  async search(params: HiveSearchRequest): Promise<HiveSearchResponse> {
+    try {
+      const response = await axios.post(this.baseUrl, params, {
+        headers: {
+          Authorization: `Bearer ${this.apiKey}`,
+          'Content-Type': 'application/json',
+        },
+      });
+      return response.data;
+    } catch (error: any) {
+      if (error.response) {
+        // Extracting error details from the API response
+        const errorMessage = error.response.data.error || error.response.data.message || 'Unknown error';
+        
+        // Throwing the custom error with the extracted message
+        throw new HiveSearchAPIError(
+          error.response.status,
+          error.response.statusText,
+          error.response.data,  // Body of the response
+          errorMessage           // Message from the response
+        );
+      } else {
+        // If no response was received, throw a general error
+        throw new Error('Unknown error occurred while calling HiveSearch API');
+      }
+    }
+  }
+}

package/src/errors.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HiveSearchAPIError = void 0;
+class HiveSearchAPIError extends Error {
+    constructor(status, statusText, body, message // Add message to hold the specific error details
+    ) {
+        super(`HiveSearch API Error: ${status} ${statusText} - ${message}`);
+        this.status = status;
+        this.statusText = statusText;
+        this.body = body;
+        this.message = message;
+        this.name = 'HiveSearchAPIError';
+    }
+}
+exports.HiveSearchAPIError = HiveSearchAPIError;

package/src/errors.ts

@@ -0,0 +1,11 @@
+export class HiveSearchAPIError extends Error {
+  constructor(
+    public status: number,
+    public statusText: string,
+    public body: any,
+    public message: string // Add message to hold the specific error details
+  ) {
+    super(`HiveSearch API Error: ${status} ${statusText} - ${message}`);
+    this.name = 'HiveSearchAPIError';
+  }
+}

package/src/index.js

@@ -0,0 +1,20 @@
+"use strict";
+// src/index.ts
+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("./client"), exports);
+__exportStar(require("./types"), exports);
+__exportStar(require("./errors"), exports);

package/src/index.ts

@@ -0,0 +1,5 @@
+// src/index.ts
+
+export * from "./client";
+export * from "./types";
+export * from "./errors";

package/src/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/src/types.ts

@@ -0,0 +1,21 @@
+export interface HiveSearchMessage {
+  role: 'user' | 'assistant';
+  content: string;
+}
+  
+export interface HiveSearchRequest {
+  prompt?: string;
+  messages?: HiveSearchMessage[];
+  temperature?: number;
+  top_k?: number;
+  top_p?: number;
+  include_data_sources?: boolean;
+}
+
+export interface HiveSearchResponse {
+  response: {
+    [key: string]: any;
+  };
+  isAdditionalDataRequired: [] | null;
+  data_sources?: string[];
+}

package/tests/client.test.js

@@ -0,0 +1,28 @@
+"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 });
+const client_1 = require("../src/client");
+const dotenv_1 = require("dotenv");
+(0, dotenv_1.config)();
+jest.setTimeout(50000);
+describe('HiveSearchAPIWrapper', () => {
+    it('should call the API and return a result', () => __awaiter(void 0, void 0, void 0, function* () {
+        var _a;
+        const client = new client_1.HiveSearchClient((_a = process.env.HIVE_API_KEY) !== null && _a !== void 0 ? _a : "");
+        const result = yield client.search({
+            prompt: 'price of ETH',
+            temperature: 0.7,
+            include_data_sources: true,
+        });
+        expect(result).toHaveProperty('response');
+        expect(result).toHaveProperty('data_sources');
+    }));
+});

package/tests/client.test.ts

@@ -0,0 +1,18 @@
+
+import { HiveSearchClient } from '../src/client';
+import { config } from 'dotenv';
+config();
+jest.setTimeout(50000);
+describe('HiveSearchAPIWrapper', () => {
+  it('should call the API and return a result', async () => {
+    const client = new HiveSearchClient(process.env.HIVE_API_KEY ?? "");
+    const result = await client.search({
+      prompt: 'price of ETH',
+      temperature: 0.7,
+      include_data_sources: true,
+    });
+
+    expect(result).toHaveProperty('response');
+    expect(result).toHaveProperty('data_sources');
+  });
+});

package/tests/hive.test.js

@@ -0,0 +1,69 @@
+"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 });
+const client_1 = require("../src/client"); // Import the HiveSearchClient
+const errors_1 = require("../src/errors");
+const dotenv_1 = require("dotenv");
+(0, dotenv_1.config)();
+jest.setTimeout(100000);
+describe('HiveSearchClient', () => {
+    const apiKey = process.env.HIVE_API_KEY; // Make sure to set your API key in the environment variables
+    if (!apiKey) {
+        throw new Error('HIVE_API_KEY environment variable not set');
+    }
+    const client = new client_1.HiveSearchClient(apiKey);
+    // Define your search inputs (similar to the Python test cases)
+    const searchInputs = [
+        { prompt: "What is current price of Eth?" },
+        { prompt: "Token info of SAI", temperature: 0.3 },
+        { prompt: "BTC token info", top_k: 5 },
+        { prompt: "top 5 crypto gainer coins", top_p: 0.9 },
+        { prompt: "BTC price", include_data_sources: true },
+        {
+            // Ensure the role values are 'user' and 'assistant'
+            messages: [
+                { role: "user", content: "What is current price of Eth?" },
+                { role: "assistant", content: "Who are you" },
+            ], // Explicitly type this as HiveSearchMessage[]
+        },
+        {
+            prompt: "top 5 crypto loser coins",
+            temperature: 0.6,
+            top_k: 10,
+            top_p: 0.95,
+            include_data_sources: false,
+        },
+    ];
+    // Parametrize test inputs and run through each
+    searchInputs.forEach((searchInput, index) => {
+        it(`should return a valid response for test case ${index + 1}`, () => __awaiter(void 0, void 0, void 0, function* () {
+            try {
+                const response = yield client.search(searchInput);
+                // Check that the response is in the correct format
+                expect(response.response).toBeInstanceOf(Object);
+                expect(response).toHaveProperty('isAdditionalDataRequired');
+            }
+            catch (error) {
+                if (error instanceof errors_1.HiveSearchAPIError) {
+                    // If it's an error, assert the error properties
+                    expect(error.status).toBeDefined();
+                    expect(error.statusText).toBeDefined();
+                    expect(error.body).toBeDefined();
+                    expect(error.message).toBeDefined();
+                }
+                else {
+                    // For other errors, fail the test
+                    fail('Unexpected error occurred: ' + error);
+                }
+            }
+        }));
+    });
+});

package/tests/hive.test.ts

@@ -0,0 +1,63 @@
+import { HiveSearchClient } from '../src/client';  // Import the HiveSearchClient
+import { HiveSearchRequest, HiveSearchMessage } from '../src/types';  // Import the necessary types
+import { HiveSearchAPIError } from '../src/errors';
+import { config } from 'dotenv';
+config();
+jest.setTimeout(100000);
+
+describe('HiveSearchClient', () => {
+  const apiKey = process.env.HIVE_API_KEY;  // Make sure to set your API key in the environment variables
+
+  if (!apiKey) {
+    throw new Error('HIVE_API_KEY environment variable not set');
+  }
+
+  const client = new HiveSearchClient(apiKey);
+
+  // Define your search inputs (similar to the Python test cases)
+  const searchInputs: Array<HiveSearchRequest> = [
+    { prompt: "What is current price of Eth?" },
+    { prompt: "Token info of SAI", temperature: 0.3 },
+    { prompt: "BTC token info", top_k: 5 },
+    { prompt: "top 5 crypto gainer coins", top_p: 0.9 },
+    { prompt: "BTC price", include_data_sources: true },
+    {
+      // Ensure the role values are 'user' and 'assistant'
+      messages: [
+        { role: "user", content: "What is current price of Eth?" },
+        { role: "assistant", content: "Who are you" },
+      ] as HiveSearchMessage[],  // Explicitly type this as HiveSearchMessage[]
+    },
+    {
+      prompt: "top 5 crypto loser coins",
+      temperature: 0.6,
+      top_k: 10,
+      top_p: 0.95,
+      include_data_sources: false,
+    },
+  ];
+
+  // Parametrize test inputs and run through each
+  searchInputs.forEach((searchInput, index) => {
+    it(`should return a valid response for test case ${index + 1}`, async () => {
+      try {
+        const response = await client.search(searchInput);
+
+        // Check that the response is in the correct format
+        expect(response.response).toBeInstanceOf(Object);
+        expect(response).toHaveProperty('isAdditionalDataRequired');
+      } catch (error) {
+        if (error instanceof HiveSearchAPIError) {
+          // If it's an error, assert the error properties
+          expect(error.status).toBeDefined();
+          expect(error.statusText).toBeDefined();
+          expect(error.body).toBeDefined();
+          expect(error.message).toBeDefined();
+        } else {
+          // For other errors, fail the test
+          fail('Unexpected error occurred: ' + error);
+        }
+      }
+    });
+  });
+});

package/tsconfig.json

@@ -0,0 +1,117 @@
+{
+  "compilerOptions": {
+    "outDir": "./dist",
+    "rootDir": "./src",
+    /* 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": "./",                                   /* 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. */
+  },
+  "include": ["src/**/*"],                        /* Include all files in the src folder */
+  "exclude": ["node_modules", "dist"]             /* Exclude node_modules and dist from compilation */
+}