vectra-js 0.9.2 → 0.9.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,38 @@
1
+ ---
2
+ name: Bug report
3
+ about: Create a report to help us improve
4
+ title: ''
5
+ labels: ''
6
+ assignees: ''
7
+
8
+ ---
9
+
10
+ **Describe the bug**
11
+ A clear and concise description of what the bug is.
12
+
13
+ **To Reproduce**
14
+ Steps to reproduce the behavior:
15
+ 1. Go to '...'
16
+ 2. Click on '....'
17
+ 3. Scroll down to '....'
18
+ 4. See error
19
+
20
+ **Expected behavior**
21
+ A clear and concise description of what you expected to happen.
22
+
23
+ **Screenshots**
24
+ If applicable, add screenshots to help explain your problem.
25
+
26
+ **Desktop (please complete the following information):**
27
+ - OS: [e.g. iOS]
28
+ - Browser [e.g. chrome, safari]
29
+ - Version [e.g. 22]
30
+
31
+ **Smartphone (please complete the following information):**
32
+ - Device: [e.g. iPhone6]
33
+ - OS: [e.g. iOS8.1]
34
+ - Browser [e.g. stock browser, safari]
35
+ - Version [e.g. 22]
36
+
37
+ **Additional context**
38
+ Add any other context about the problem here.
@@ -0,0 +1,20 @@
1
+ ---
2
+ name: Feature request
3
+ about: Suggest an idea for this project
4
+ title: ''
5
+ labels: ''
6
+ assignees: ''
7
+
8
+ ---
9
+
10
+ **Is your feature request related to a problem? Please describe.**
11
+ A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
12
+
13
+ **Describe the solution you'd like**
14
+ A clear and concise description of what you want to happen.
15
+
16
+ **Describe alternatives you've considered**
17
+ A clear and concise description of any alternative solutions or features you've considered.
18
+
19
+ **Additional context**
20
+ Add any other context or screenshots about the feature request here.
@@ -0,0 +1,11 @@
1
+ # To get started with Dependabot version updates, you'll need to specify which
2
+ # package ecosystems to update and where the package manifests are located.
3
+ # Please see the documentation for all configuration options:
4
+ # https://docs.github.com/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file
5
+
6
+ version: 2
7
+ updates:
8
+ - package-ecosystem: "npm" # See documentation for possible values
9
+ directory: "/" # Location of package manifests
10
+ schedule:
11
+ interval: "weekly"
@@ -0,0 +1,39 @@
1
+ name: Publish to npm
2
+
3
+ on:
4
+ push:
5
+ branches:
6
+ - master
7
+
8
+ jobs:
9
+ publish:
10
+ runs-on: ubuntu-latest
11
+
12
+ environment: Build
13
+
14
+ permissions:
15
+ contents: read
16
+
17
+ steps:
18
+ - uses: actions/checkout@v4
19
+
20
+ - uses: actions/setup-node@v4
21
+ with:
22
+ node-version: 20
23
+ registry-url: https://registry.npmjs.org
24
+
25
+ - uses: pnpm/action-setup@v3
26
+ with:
27
+ version: 9
28
+
29
+ - name: Install dependencies
30
+ run: pnpm install --frozen-lockfile
31
+
32
+ - name: Configure npm auth
33
+ run: |
34
+ echo "//registry.npmjs.org/:_authToken=${NPM_TOKEN}" > ~/.npmrc
35
+ env:
36
+ NPM_TOKEN: ${{ secrets.NPM_KEY }}
37
+
38
+ - name: Publish to npm
39
+ run: pnpm publish --no-git-checks --access public
@@ -0,0 +1,128 @@
1
+ # Contributor Covenant Code of Conduct
2
+
3
+ ## Our Pledge
4
+
5
+ We as members, contributors, and leaders pledge to make participation in our
6
+ community a harassment-free experience for everyone, regardless of age, body
7
+ size, visible or invisible disability, ethnicity, sex characteristics, gender
8
+ identity and expression, level of experience, education, socio-economic status,
9
+ nationality, personal appearance, race, religion, or sexual identity
10
+ and orientation.
11
+
12
+ We pledge to act and interact in ways that contribute to an open, welcoming,
13
+ diverse, inclusive, and healthy community.
14
+
15
+ ## Our Standards
16
+
17
+ Examples of behavior that contributes to a positive environment for our
18
+ community include:
19
+
20
+ * Demonstrating empathy and kindness toward other people
21
+ * Being respectful of differing opinions, viewpoints, and experiences
22
+ * Giving and gracefully accepting constructive feedback
23
+ * Accepting responsibility and apologizing to those affected by our mistakes,
24
+ and learning from the experience
25
+ * Focusing on what is best not just for us as individuals, but for the
26
+ overall community
27
+
28
+ Examples of unacceptable behavior include:
29
+
30
+ * The use of sexualized language or imagery, and sexual attention or
31
+ advances of any kind
32
+ * Trolling, insulting or derogatory comments, and personal or political attacks
33
+ * Public or private harassment
34
+ * Publishing others' private information, such as a physical or email
35
+ address, without their explicit permission
36
+ * Other conduct which could reasonably be considered inappropriate in a
37
+ professional setting
38
+
39
+ ## Enforcement Responsibilities
40
+
41
+ Community leaders are responsible for clarifying and enforcing our standards of
42
+ acceptable behavior and will take appropriate and fair corrective action in
43
+ response to any behavior that they deem inappropriate, threatening, offensive,
44
+ or harmful.
45
+
46
+ Community leaders have the right and responsibility to remove, edit, or reject
47
+ comments, commits, code, wiki edits, issues, and other contributions that are
48
+ not aligned to this Code of Conduct, and will communicate reasons for moderation
49
+ decisions when appropriate.
50
+
51
+ ## Scope
52
+
53
+ This Code of Conduct applies within all community spaces, and also applies when
54
+ an individual is officially representing the community in public spaces.
55
+ Examples of representing our community include using an official e-mail address,
56
+ posting via an official social media account, or acting as an appointed
57
+ representative at an online or offline event.
58
+
59
+ ## Enforcement
60
+
61
+ Instances of abusive, harassing, or otherwise unacceptable behavior may be
62
+ reported to the community leaders responsible for enforcement at
63
+ astroabhi.abhi@gmail.com.
64
+ All complaints will be reviewed and investigated promptly and fairly.
65
+
66
+ All community leaders are obligated to respect the privacy and security of the
67
+ reporter of any incident.
68
+
69
+ ## Enforcement Guidelines
70
+
71
+ Community leaders will follow these Community Impact Guidelines in determining
72
+ the consequences for any action they deem in violation of this Code of Conduct:
73
+
74
+ ### 1. Correction
75
+
76
+ **Community Impact**: Use of inappropriate language or other behavior deemed
77
+ unprofessional or unwelcome in the community.
78
+
79
+ **Consequence**: A private, written warning from community leaders, providing
80
+ clarity around the nature of the violation and an explanation of why the
81
+ behavior was inappropriate. A public apology may be requested.
82
+
83
+ ### 2. Warning
84
+
85
+ **Community Impact**: A violation through a single incident or series
86
+ of actions.
87
+
88
+ **Consequence**: A warning with consequences for continued behavior. No
89
+ interaction with the people involved, including unsolicited interaction with
90
+ those enforcing the Code of Conduct, for a specified period of time. This
91
+ includes avoiding interactions in community spaces as well as external channels
92
+ like social media. Violating these terms may lead to a temporary or
93
+ permanent ban.
94
+
95
+ ### 3. Temporary Ban
96
+
97
+ **Community Impact**: A serious violation of community standards, including
98
+ sustained inappropriate behavior.
99
+
100
+ **Consequence**: A temporary ban from any sort of interaction or public
101
+ communication with the community for a specified period of time. No public or
102
+ private interaction with the people involved, including unsolicited interaction
103
+ with those enforcing the Code of Conduct, is allowed during this period.
104
+ Violating these terms may lead to a permanent ban.
105
+
106
+ ### 4. Permanent Ban
107
+
108
+ **Community Impact**: Demonstrating a pattern of violation of community
109
+ standards, including sustained inappropriate behavior, harassment of an
110
+ individual, or aggression toward or disparagement of classes of individuals.
111
+
112
+ **Consequence**: A permanent ban from any sort of public interaction within
113
+ the community.
114
+
115
+ ## Attribution
116
+
117
+ This Code of Conduct is adapted from the [Contributor Covenant][homepage],
118
+ version 2.0, available at
119
+ https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
120
+
121
+ Community Impact Guidelines were inspired by [Mozilla's code of conduct
122
+ enforcement ladder](https://github.com/mozilla/diversity).
123
+
124
+ [homepage]: https://www.contributor-covenant.org
125
+
126
+ For answers to common questions about this code of conduct, see the FAQ at
127
+ https://www.contributor-covenant.org/faq. Translations are available at
128
+ https://www.contributor-covenant.org/translations.
package/README.md CHANGED
@@ -161,6 +161,13 @@ const config = {
161
161
  - `enrichment`: boolean; generate `summary`, `keywords`, `hypothetical_questions`
162
162
  - Callbacks
163
163
  - `callbacks`: array of handlers; use `LoggingCallbackHandler` or `StructuredLoggingCallbackHandler`
164
+ - Observability
165
+ - `enabled`: boolean; enable SQLite-based observability (default: false)
166
+ - `sqlitePath`: string; path to SQLite database file (default: 'vectra-observability.db')
167
+ - `projectId`: string; project identifier for multi-project support (default: 'default')
168
+ - `trackMetrics`: boolean; track latency and other metrics
169
+ - `trackTraces`: boolean; track detailed workflow traces
170
+ - `sessionTracking`: boolean; track chat sessions
164
171
  - Index Helpers (Postgres + Prisma)
165
172
  - `ensureIndexes()`: creates ivfflat and GIN FTS indexes and optional `tsvector` trigger
166
173
 
@@ -601,6 +608,29 @@ const { StructuredLoggingCallbackHandler } = require('vectra-js/src/callbacks');
601
608
  const config = { callbacks: [ new StructuredLoggingCallbackHandler() ] };
602
609
  ```
603
610
 
611
+ ### Observability
612
+
613
+ Built-in SQLite-based observability to track metrics, traces, and sessions.
614
+
615
+ ```javascript
616
+ const config = {
617
+ // ...
618
+ observability: {
619
+ enabled: true,
620
+ sqlitePath: 'vectra-observability.db',
621
+ projectId: 'my-project',
622
+ trackMetrics: true,
623
+ trackTraces: true,
624
+ sessionTracking: true
625
+ }
626
+ };
627
+ ```
628
+
629
+ This tracks:
630
+ - **Metrics**: Latency (ingest, query).
631
+ - **Traces**: Detailed spans for retrieval, generation, and ingestion workflows.
632
+ - **Sessions**: Chat session history and last query tracking.
633
+
604
634
  ### Vector Stores
605
635
  - Prisma (Postgres + pgvector), Chroma, Qdrant, Milvus.
606
636
  - Configure `database.type`, `tableName`, `columnMap`, `clientInstance`.
package/bin/vectra.js CHANGED
@@ -28,12 +28,18 @@ async function run() {
28
28
 
29
29
  if (cmd === 'webconfig') {
30
30
  const cfgPath = configPath || path.join(process.cwd(), 'vectra-config.json');
31
- startWebConfig(cfgPath);
31
+ startWebConfig(cfgPath, 'webconfig');
32
32
  return;
33
33
  }
34
34
 
35
- if (!cmd || (!target && cmd !== 'webconfig')) {
36
- console.error('Usage: vectra <ingest|query|webconfig> <path|text> [--config=path] [--stream]');
35
+ if (cmd === 'dashboard') {
36
+ const cfgPath = configPath || path.join(process.cwd(), 'vectra-config.json');
37
+ startWebConfig(cfgPath, 'dashboard');
38
+ return;
39
+ }
40
+
41
+ if (!cmd || (!target && cmd !== 'webconfig' && cmd !== 'dashboard')) {
42
+ console.error('Usage: vectra <ingest|query|webconfig|dashboard> <path|text> [--config=path] [--stream]');
37
43
  process.exit(1);
38
44
  }
39
45
 
package/package.json CHANGED
@@ -1,19 +1,14 @@
1
1
  {
2
2
  "name": "vectra-js",
3
- "version": "0.9.2",
3
+ "version": "0.9.4",
4
4
  "description": "A production-ready, provider-agnostic Node.js SDK for End-to-End RAG pipelines.",
5
5
  "main": "index.js",
6
- "scripts": {
7
- "test": "echo \"Error: no test specified\" && exit 1",
8
- "prisma:generate": "prisma generate",
9
- "lint": "eslint . --ext .js,.cjs,.mjs",
10
- "lint:fix": "eslint . --ext .js,.cjs,.mjs --fix",
11
- "prepublishOnly": "pnpm run lint",
12
- "publish": "npm publish --access public"
13
- },
14
6
  "bin": {
15
7
  "vectra": "bin/vectra.js"
16
8
  },
9
+ "publishConfig": {
10
+ "access": "public"
11
+ },
17
12
  "keywords": [
18
13
  "rag",
19
14
  "llm",
@@ -31,24 +26,31 @@
31
26
  },
32
27
  "homepage": "https://github.com/iamabhishek-n/vectra-js#readme",
33
28
  "author": "Abhishek N",
34
- "license": "MIT",
29
+ "license": "GPL-3.0",
35
30
  "dependencies": {
36
- "@anthropic-ai/sdk": "^0.20.0",
37
- "@google/genai": "^1.30.0",
38
- "openai": "^4.0.0",
39
- "zod": "^3.22.0",
40
- "pdf-parse": "^1.1.1",
41
- "mammoth": "^1.7.0",
31
+ "@anthropic-ai/sdk": "^0.20.9",
32
+ "@google/genai": "^1.34.0",
33
+ "dotenv": "^16.6.1",
34
+ "mammoth": "^1.11.0",
35
+ "openai": "^6.15.0",
36
+ "pdf-parse": "^2.4.5",
37
+ "sqlite3": "^5.1.7",
38
+ "uuid": "^9.0.1",
42
39
  "xlsx": "^0.18.5",
43
- "uuid": "^9.0.0",
44
- "dotenv": "^16.0.0"
40
+ "zod": "^3.25.76"
45
41
  },
46
42
  "peerDependencies": {
47
43
  "@prisma/client": "^5.0.0"
48
44
  },
49
45
  "devDependencies": {
50
- "prisma": "^5.22.0",
51
- "eslint": "^9.13.0",
52
- "globals": "^13.24.0"
46
+ "eslint": "^9.39.2",
47
+ "globals": "^16.5.0",
48
+ "prisma": "^7.2.0"
49
+ },
50
+ "scripts": {
51
+ "test": "echo \"Error: no test specified\" && exit 1",
52
+ "prisma:generate": "prisma generate",
53
+ "lint": "eslint . --ext .js,.cjs,.mjs",
54
+ "lint:fix": "eslint . --ext .js,.cjs,.mjs --fix"
53
55
  }
54
- }
56
+ }
@@ -15,11 +15,22 @@ class ChromaVectorStore extends VectorStore {
15
15
  }
16
16
  }
17
17
 
18
+ _cleanMetadata(meta) {
19
+ if (!meta) return {};
20
+ const out = {};
21
+ for (const [k, v] of Object.entries(meta)) {
22
+ if (v !== undefined && v !== null) {
23
+ out[k] = v;
24
+ }
25
+ }
26
+ return out;
27
+ }
28
+
18
29
  async addDocuments(docs) {
19
30
  await this._init();
20
31
  const ids = docs.map((d) => d.id || uuidv4());
21
32
  const embeddings = docs.map(d => d.embedding);
22
- const metadatas = docs.map(d => d.metadata);
33
+ const metadatas = docs.map(d => this._cleanMetadata(d.metadata));
23
34
  const documents = docs.map(d => d.content);
24
35
 
25
36
  await this.collection.add({
@@ -34,7 +45,7 @@ class ChromaVectorStore extends VectorStore {
34
45
  await this._init();
35
46
  const ids = docs.map((d) => d.id || uuidv4());
36
47
  const embeddings = docs.map(d => d.embedding);
37
- const metadatas = docs.map(d => d.metadata);
48
+ const metadatas = docs.map(d => this._cleanMetadata(d.metadata));
38
49
  const documents = docs.map(d => d.content);
39
50
  if (typeof this.collection.upsert === 'function') {
40
51
  await this.collection.upsert({ ids, embeddings, metadatas, documents });
package/src/config.js CHANGED
@@ -114,6 +114,15 @@ const RAGConfigSchema = z.object({
114
114
  prompts: z.object({ query: z.string().optional(), reranking: z.string().optional() }).optional(),
115
115
  tracing: z.object({ enable: z.boolean().default(false) }).optional(),
116
116
  callbacks: z.array(z.custom((val) => true)).optional(),
117
+ observability: z.object({
118
+ enabled: z.boolean().default(false),
119
+ sqlitePath: z.string().default('vectra-observability.db'),
120
+ projectId: z.string().default('default'),
121
+ trackMetrics: z.boolean().default(true),
122
+ trackTraces: z.boolean().default(true),
123
+ trackLogs: z.boolean().default(true),
124
+ sessionTracking: z.boolean().default(true)
125
+ }).default({})
117
126
  });
118
127
 
119
128
  module.exports = {