@mendable/firecrawl-js 0.0.29-beta.1 → 0.0.29-beta.3

package/build/__tests__/e2e_withAuth/index.test.js

@@ -0,0 +1,138 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const index_1 = __importDefault(require("../../index"));
+const uuid_1 = require("uuid");
+const dotenv_1 = __importDefault(require("dotenv"));
+dotenv_1.default.config();
+const TEST_API_KEY = process.env.TEST_API_KEY;
+const API_URL = "http://127.0.0.1:3002";
+describe('FirecrawlApp E2E Tests', () => {
+    test.concurrent('should throw error for no API key', () => {
+        expect(() => {
+            new index_1.default({ apiKey: null, apiUrl: API_URL });
+        }).toThrow("No API key provided");
+    });
+    test.concurrent('should throw error for invalid API key on scrape', async () => {
+        const invalidApp = new index_1.default({ apiKey: "invalid_api_key", apiUrl: API_URL });
+        await expect(invalidApp.scrapeUrl('https://roastmywebsite.ai')).rejects.toThrow("Request failed with status code 401");
+    });
+    test.concurrent('should throw error for blocklisted URL on scrape', async () => {
+        const app = new index_1.default({ apiKey: TEST_API_KEY, apiUrl: API_URL });
+        const blocklistedUrl = "https://facebook.com/fake-test";
+        await expect(app.scrapeUrl(blocklistedUrl)).rejects.toThrow("Request failed with status code 403");
+    });
+    test.concurrent('should return successful response with valid preview token', async () => {
+        const app = new index_1.default({ apiKey: "this_is_just_a_preview_token", apiUrl: API_URL });
+        const response = await app.scrapeUrl('https://roastmywebsite.ai');
+        expect(response).not.toBeNull();
+        expect(response.data?.content).toContain("_Roast_");
+    }, 30000); // 30 seconds timeout
+    test.concurrent('should return successful response for valid scrape', async () => {
+        const app = new index_1.default({ apiKey: TEST_API_KEY, apiUrl: API_URL });
+        const response = await app.scrapeUrl('https://roastmywebsite.ai');
+        expect(response).not.toBeNull();
+        expect(response.data?.content).toContain("_Roast_");
+        expect(response.data).toHaveProperty('markdown');
+        expect(response.data).toHaveProperty('metadata');
+        expect(response.data).not.toHaveProperty('html');
+    }, 30000); // 30 seconds timeout
+    test.concurrent('should return successful response with valid API key and include HTML', async () => {
+        const app = new index_1.default({ apiKey: TEST_API_KEY, apiUrl: API_URL });
+        const response = await app.scrapeUrl('https://roastmywebsite.ai', { pageOptions: { includeHtml: true } });
+        expect(response).not.toBeNull();
+        expect(response.data?.content).toContain("_Roast_");
+        expect(response.data?.markdown).toContain("_Roast_");
+        expect(response.data?.html).toContain("<h1");
+    }, 30000); // 30 seconds timeout
+    test.concurrent('should return successful response for valid scrape with PDF file', async () => {
+        const app = new index_1.default({ apiKey: TEST_API_KEY, apiUrl: API_URL });
+        const response = await app.scrapeUrl('https://arxiv.org/pdf/astro-ph/9301001.pdf');
+        expect(response).not.toBeNull();
+        expect(response.data?.content).toContain('We present spectrophotometric observations of the Broad Line Radio Galaxy');
+    }, 30000); // 30 seconds timeout
+    test.concurrent('should return successful response for valid scrape with PDF file without explicit extension', async () => {
+        const app = new index_1.default({ apiKey: TEST_API_KEY, apiUrl: API_URL });
+        const response = await app.scrapeUrl('https://arxiv.org/pdf/astro-ph/9301001');
+        expect(response).not.toBeNull();
+        expect(response.data?.content).toContain('We present spectrophotometric observations of the Broad Line Radio Galaxy');
+    }, 30000); // 30 seconds timeout
+    test.concurrent('should throw error for invalid API key on crawl', async () => {
+        const invalidApp = new index_1.default({ apiKey: "invalid_api_key", apiUrl: API_URL });
+        await expect(invalidApp.crawlUrl('https://roastmywebsite.ai')).rejects.toThrow("Request failed with status code 401");
+    });
+    test.concurrent('should throw error for blocklisted URL on crawl', async () => {
+        const app = new index_1.default({ apiKey: TEST_API_KEY, apiUrl: API_URL });
+        const blocklistedUrl = "https://twitter.com/fake-test";
+        await expect(app.crawlUrl(blocklistedUrl)).rejects.toThrow("Request failed with status code 403");
+    });
+    test.concurrent('should return successful response for crawl and wait for completion', async () => {
+        const app = new index_1.default({ apiKey: TEST_API_KEY, apiUrl: API_URL });
+        const response = await app.crawlUrl('https://roastmywebsite.ai', { crawlerOptions: { excludes: ['blog/*'] } }, true, 30);
+        expect(response).not.toBeNull();
+        expect(response[0].content).toContain("_Roast_");
+    }, 60000); // 60 seconds timeout
+    test.concurrent('should handle idempotency key for crawl', async () => {
+        const app = new index_1.default({ apiKey: TEST_API_KEY, apiUrl: API_URL });
+        const uniqueIdempotencyKey = (0, uuid_1.v4)();
+        const response = await app.crawlUrl('https://roastmywebsite.ai', { crawlerOptions: { excludes: ['blog/*'] } }, false, 2, uniqueIdempotencyKey);
+        expect(response).not.toBeNull();
+        expect(response.jobId).toBeDefined();
+        await expect(app.crawlUrl('https://roastmywebsite.ai', { crawlerOptions: { excludes: ['blog/*'] } }, true, 2, uniqueIdempotencyKey)).rejects.toThrow("Request failed with status code 409");
+    });
+    test.concurrent('should check crawl status', async () => {
+        const app = new index_1.default({ apiKey: TEST_API_KEY, apiUrl: API_URL });
+        const response = await app.crawlUrl('https://roastmywebsite.ai', { crawlerOptions: { excludes: ['blog/*'] } }, false);
+        expect(response).not.toBeNull();
+        expect(response.jobId).toBeDefined();
+        let statusResponse = await app.checkCrawlStatus(response.jobId);
+        const maxChecks = 15;
+        let checks = 0;
+        while (statusResponse.status === 'active' && checks < maxChecks) {
+            await new Promise(resolve => setTimeout(resolve, 1000));
+            expect(statusResponse.partial_data).not.toBeNull();
+            statusResponse = await app.checkCrawlStatus(response.jobId);
+            checks++;
+        }
+        expect(statusResponse).not.toBeNull();
+        expect(statusResponse.status).toBe('completed');
+        expect(statusResponse?.data?.length).toBeGreaterThan(0);
+    }, 35000); // 35 seconds timeout
+    test.concurrent('should return successful response for search', async () => {
+        const app = new index_1.default({ apiKey: TEST_API_KEY, apiUrl: API_URL });
+        const response = await app.search("test query");
+        expect(response).not.toBeNull();
+        expect(response?.data?.[0]?.content).toBeDefined();
+        expect(response?.data?.length).toBeGreaterThan(2);
+    }, 30000); // 30 seconds timeout
+    test.concurrent('should throw error for invalid API key on search', async () => {
+        const invalidApp = new index_1.default({ apiKey: "invalid_api_key", apiUrl: API_URL });
+        await expect(invalidApp.search("test query")).rejects.toThrow("Request failed with status code 401");
+    });
+    test.concurrent('should perform LLM extraction', async () => {
+        const app = new index_1.default({ apiKey: TEST_API_KEY, apiUrl: API_URL });
+        const response = await app.scrapeUrl("https://mendable.ai", {
+            extractorOptions: {
+                mode: 'llm-extraction',
+                extractionPrompt: "Based on the information on the page, find what the company's mission is and whether it supports SSO, and whether it is open source",
+                extractionSchema: {
+                    type: 'object',
+                    properties: {
+                        company_mission: { type: 'string' },
+                        supports_sso: { type: 'boolean' },
+                        is_open_source: { type: 'boolean' }
+                    },
+                    required: ['company_mission', 'supports_sso', 'is_open_source']
+                }
+            }
+        });
+        expect(response).not.toBeNull();
+        expect(response.data?.llm_extraction).toBeDefined();
+        const llmExtraction = response.data?.llm_extraction;
+        expect(llmExtraction?.company_mission).toBeDefined();
+        expect(typeof llmExtraction?.supports_sso).toBe('boolean');
+        expect(typeof llmExtraction?.is_open_source).toBe('boolean');
+    }, 30000); // 30 seconds timeout
+});

package/build/__tests__/index.test.js

@@ -0,0 +1,41 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const globals_1 = require("@jest/globals");
+const axios_1 = __importDefault(require("axios"));
+const index_1 = __importDefault(require("../index"));
+const promises_1 = require("fs/promises");
+const path_1 = require("path");
+// Mock jest and set the type
+globals_1.jest.mock('axios');
+const mockedAxios = axios_1.default;
+// Get the fixure data from the JSON file in ./fixtures
+async function loadFixture(name) {
+    return await (0, promises_1.readFile)((0, path_1.join)(__dirname, 'fixtures', `${name}.json`), 'utf-8');
+}
+(0, globals_1.describe)('the firecrawl JS SDK', () => {
+    (0, globals_1.test)('Should require an API key to instantiate FirecrawlApp', async () => {
+        const fn = () => {
+            new index_1.default({ apiKey: undefined });
+        };
+        (0, globals_1.expect)(fn).toThrow('No API key provided');
+    });
+    (0, globals_1.test)('Should return scraped data from a /scrape API call', async () => {
+        const mockData = await loadFixture('scrape');
+        mockedAxios.post.mockResolvedValue({
+            status: 200,
+            data: JSON.parse(mockData),
+        });
+        const apiKey = 'YOUR_API_KEY';
+        const app = new index_1.default({ apiKey });
+        // Scrape a single URL
+        const url = 'https://mendable.ai';
+        const scrapedData = await app.scrapeUrl(url);
+        (0, globals_1.expect)(mockedAxios.post).toHaveBeenCalledTimes(1);
+        (0, globals_1.expect)(mockedAxios.post).toHaveBeenCalledWith(globals_1.expect.stringMatching(/^https:\/\/api.firecrawl.dev/), globals_1.expect.objectContaining({ url }), globals_1.expect.objectContaining({ headers: globals_1.expect.objectContaining({ 'Authorization': `Bearer ${apiKey}` }) }));
+        (0, globals_1.expect)(scrapedData.success).toBe(true);
+        (0, globals_1.expect)(scrapedData?.data?.metadata.title).toEqual('Mendable');
+    });
+});

package/build/index.js

@@ -1,10 +1,15 @@
-import axios from "axios";
-import { z } from "zod";
-import { zodToJsonSchema } from "zod-to-json-schema";
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const axios_1 = __importDefault(require("axios"));
+const zod_1 = require("zod");
+const zod_to_json_schema_1 = require("zod-to-json-schema");
 /**
  * Main class for interacting with the Firecrawl API.
  */
-export default class FirecrawlApp {
+class FirecrawlApp {
     /**
      * Initializes a new instance of the FirecrawlApp class.
      * @param {FirecrawlAppConfig} config - Configuration options for the FirecrawlApp instance.
@@ -31,8 +36,8 @@ export default class FirecrawlApp {
         if (params?.extractorOptions?.extractionSchema) {
             let schema = params.extractorOptions.extractionSchema;
             // Check if schema is an instance of ZodSchema to correctly identify Zod schemas
-            if (schema instanceof z.ZodSchema) {
-                schema = zodToJsonSchema(schema);
+            if (schema instanceof zod_1.z.ZodSchema) {
+                schema = (0, zod_to_json_schema_1.zodToJsonSchema)(schema);
             }
             jsonData = {
                 ...jsonData,
@@ -44,7 +49,7 @@ export default class FirecrawlApp {
             };
         }
         try {
-            const response = await axios.post(this.apiUrl + "/v0/scrape", jsonData, { headers });
+            const response = await axios_1.default.post(this.apiUrl + "/v0/scrape", jsonData, { headers });
             if (response.status === 200) {
                 const responseData = response.data;
                 if (responseData.success) {
@@ -79,7 +84,7 @@ export default class FirecrawlApp {
             jsonData = { ...jsonData, ...params };
         }
         try {
-            const response = await axios.post(this.apiUrl + "/v0/search", jsonData, { headers });
+            const response = await axios_1.default.post(this.apiUrl + "/v0/search", jsonData, { headers });
             if (response.status === 200) {
                 const responseData = response.data;
                 if (responseData.success) {
@@ -185,7 +190,7 @@ export default class FirecrawlApp {
      * @returns {Promise<AxiosResponse>} The response from the POST request.
      */
     postRequest(url, data, headers) {
-        return axios.post(url, data, { headers });
+        return axios_1.default.post(url, data, { headers });
     }
     /**
      * Sends a GET request to the specified URL.
@@ -194,7 +199,7 @@ export default class FirecrawlApp {
      * @returns {Promise<AxiosResponse>} The response from the GET request.
      */
     getRequest(url, headers) {
-        return axios.get(url, { headers });
+        return axios_1.default.get(url, { headers });
     }
     /**
      * Monitors the status of a crawl job until completion or failure.
@@ -246,3 +251,4 @@ export default class FirecrawlApp {
         }
     }
 }
+exports.default = FirecrawlApp;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mendable/firecrawl-js",
-  "version": "0.0.29-beta.1",
+  "version": "0.0.29-beta.3",
   "description": "JavaScript SDK for Firecrawl API",
   "main": "build/index.js",
   "types": "types/index.d.ts",
@@ -8,6 +8,7 @@
   "scripts": {
     "build": "tsc",
     "build-and-publish": "npm run build && npm publish --access public",
+    "build-cjs": "tsc --project tsconfig.cjs.json",
     "publish-beta": "npm run build && npm publish --access public --tag beta",
     "test": "jest src/__tests__/**/*.test.ts"
   },
@@ -18,6 +19,7 @@
   "author": "Mendable.ai",
   "license": "MIT",
   "dependencies": {
+    "@tsconfig/recommended": "^1.0.6",
     "axios": "^1.6.8",
     "dotenv": "^16.4.5",
     "uuid": "^9.0.1",
@@ -38,7 +40,7 @@
     "@types/uuid": "^9.0.8",
     "jest": "^29.7.0",
     "ts-jest": "^29.1.2",
-    "typescript": "^5.4.5"
+    "typescript": "~5.1.6"
   },
   "keywords": [
     "firecrawl",

package/src/__tests__/e2e_withAuth/index.test.ts

@@ -1,4 +1,4 @@
-import FirecrawlApp from '../../index';
+import FirecrawlApp from '../../index.js';
 import { v4 as uuidv4 } from 'uuid';
 import dotenv from 'dotenv';
 

package/src/__tests__/index.test.ts

@@ -1,6 +1,6 @@
 import { describe, test, expect, jest } from '@jest/globals';
 import axios from 'axios';
-import FirecrawlApp from '../index';
+import FirecrawlApp from '../index.js';
 
 import { readFile } from 'fs/promises';
 import { join } from 'path';

package/tsconfig.cjs.json

@@ -0,0 +1,14 @@
+{
+    "extends": "./tsconfig.json",
+    "compilerOptions": {
+      "module": "commonjs",
+      "declaration": false
+    },
+    "exclude": [
+      "node_modules",
+      "dist",
+      "docs",
+      "**/tests",
+      "build"
+    ]
+  }

package/tsconfig.json

@@ -1,117 +1,33 @@
 {
+  "extends": "@tsconfig/recommended",
   "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 */
-    // "lib": [],                                        /* Specify a set of bundled library declaration files that describe the target runtime environment. */
-    // "jsx": "preserve",                                /* Specify what JSX code is generated. */
-    // "experimentalDecorators": true,                   /* Enable experimental support for legacy experimental decorators. */
-    // "emitDecoratorMetadata": true,                    /* Emit design-type metadata for decorated declarations in source files. */
-    // "jsxFactory": "",                                 /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h'. */
-    // "jsxFragmentFactory": "",                         /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */
-    // "jsxImportSource": "",                            /* Specify module specifier used to import the JSX factory functions when using 'jsx: react-jsx*'. */
-    // "reactNamespace": "",                             /* Specify the object invoked for 'createElement'. This only applies when targeting 'react' JSX emit. */
-    // "noLib": true,                                    /* Disable including any library files, including the default lib.d.ts. */
-    // "useDefineForClassFields": true,                  /* Emit ECMAScript-standard-compliant class fields. */
-    // "moduleDetection": "auto",                        /* Control what method is used to detect module-format JS files. */
-
-    /* Modules */
-    "rootDir": "./src",                                  /* Specify the root folder within your source files. */
-    
+    "outDir": "../dist",
+    "rootDir": "./src",
     "target": "ES2021",
     "lib": [
       "ES2021",
       "ES2022.Object",
       "DOM"
     ],
-    "module": "NodeNext",
-    "moduleResolution": "nodenext",/* 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": "./build",                                   /* 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": "./types",                           /* 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. */
+    "module": "ES2020",
+    "moduleResolution": "nodenext",
+    "esModuleInterop": false,
+    "declaration": true,
+    "noImplicitReturns": true,
+    "noFallthroughCasesInSwitch": true,
+    "noUnusedLocals": true,
+    "noUnusedParameters": true,
+    "useDefineForClassFields": true,
+    "strictPropertyInitialization": false,
+    "allowJs": true,
+    "strict": false
   },
-  "include": ["src/**/*"],
-  "exclude": ["node_modules", "dist", "**/__tests__/*"]
-}
+  "include": [
+    "src/**/*"
+  ],
+  "exclude": [
+    "node_modules",
+    "dist",
+    "docs"
+  ]
+}

package/types/__tests__/e2e_withAuth/index.test.d.ts

@@ -0,0 +1 @@
+export {};

package/types/__tests__/index.test.d.ts

@@ -0,0 +1 @@
+export {};