Fixed all the security issues and fixed all the package.json scripts #69
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This pull request introduces significant updates to the codebase, including configuration enhancements, new documentation, and the addition of several utility classes. The changes aim to improve configuration flexibility, enhance documentation for the Vectra library, and provide new functionalities for vector database operations.
Configuration Updates:
.eslintrc.json: Replaced the base configuration with a detailed ESLint setup, including environment settings (node,es2021,mocha), TypeScript-specific rules, and custom linting rules for code style.api-extractor.json: Replaced the inherited configuration with a comprehensive setup for API Extractor, enabling features like DTS rollup, TSDoc metadata generation, and API report generation.Documentation Enhancements:
docs/.nojekyll: Added to prevent GitHub Pages from using Jekyll, ensuring compatibility with TypeDoc-generated documentation.docs/README.md: Introduced a detailed README for the Vectra library, explaining its purpose, installation, usage, and limitations as a local vector database.New Utility Classes:
FileFetcher: Added a class for fetching text content from local files, implementing theTextFetcherinterface.GPT3Tokenizer: Added a tokenizer class for encoding and decoding text using the GPT-3 tokenizer, implementing theTokenizerinterface.ItemSelector: Added a utility class for vector operations, including cosine similarity, normalization, and metadata filtering.LocalDocument: Added a class representing a document stored in a local index, with methods for metadata and text retrieval.LocalDocumentResult: Added a class extendingLocalDocumentto represent query results, including methods for rendering text sections and retrieving matched chunks.