@memvid/sdk 2.0.113

package/LICENSE

@@ -0,0 +1,190 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to the Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2024 Memvid Inc.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,244 @@
+# @memvid/sdk
+
+Single-file AI memory system for Node.js. Store documents, search with BM25 ranking, and run retrieval-augmented generation (RAG) queries from a portable `.mv2` file.
+
+Built on Rust via N-API for native performance. No database setup, no network dependencies, no configuration files.
+
+## Install
+
+```bash
+npm install @memvid/sdk
+```
+
+## Quick start
+
+```typescript
+import { use, create } from "@memvid/sdk";
+
+// Create a new memory file
+const mv = await use("basic", "notes.mv2", { mode: "auto" });
+
+// Store a document
+await mv.put({
+  title: "Project kickoff",
+  label: "meeting",
+  text: "Discussed timeline, assigned tasks to team members.",
+  metadata: { date: "2024-01-15" },
+});
+
+// Search by keyword
+const results = await mv.find("timeline");
+console.log(results.hits);
+
+// Ask a question (retrieves relevant context)
+const answer = await mv.ask("What was discussed in the kickoff?");
+console.log(answer.context);
+
+// Commit and close
+await mv.seal();
+```
+
+## Core API
+
+### Opening a memory
+
+```typescript
+const mv = await use(kind, path, options?)
+```
+
+| Parameter | Type | Description |
+|-----------|------|-------------|
+| `kind` | `string` | Adapter type: `"basic"`, `"langchain"`, `"llamaindex"`, `"openai"`, `"crewai"`, `"vercel-ai"`, `"autogen"` |
+| `path` | `string` | Path to `.mv2` file |
+| `options.mode` | `string` | `"open"` (default), `"create"`, or `"auto"` |
+| `options.enableLex` | `boolean` | Enable lexical index (default: `true`) |
+| `options.enableVec` | `boolean` | Enable vector index (default: `true`) |
+| `options.readOnly` | `boolean` | Open in read-only mode (default: `false`) |
+| `options.apiKey` | `string` | Memvid API key for capacity beyond 1GB |
+
+### Storing documents
+
+```typescript
+await mv.put({
+  title: "Document title",
+  label: "category",
+  text: "Document content...",
+  metadata: { key: "value" },
+  uri: "mv2://custom/path",
+  tags: ["tag1", "tag2"],
+});
+```
+
+### Batch ingestion
+
+For bulk imports, `putMany` processes documents in parallel:
+
+```typescript
+const docs = [
+  { title: "Doc 1", text: "First document content..." },
+  { title: "Doc 2", text: "Second document content..." },
+  // ... thousands more
+];
+
+const frameIds = await mv.putMany(docs, { compressionLevel: 3 });
+console.log(`Ingested ${frameIds.length} documents`);
+```
+
+### Searching
+
+```typescript
+const results = await mv.find(query, options?)
+```
+
+| Option | Type | Description |
+|--------|------|-------------|
+| `k` | `number` | Number of results (default: `10`) |
+| `snippetChars` | `number` | Snippet length (default: `240`) |
+| `scope` | `string` | Filter by URI prefix |
+
+### Retrieval-augmented generation
+
+```typescript
+const response = await mv.ask(question, options?)
+```
+
+| Option | Type | Description |
+|--------|------|-------------|
+| `k` | `number` | Documents to retrieve (default: `6`) |
+| `mode` | `string` | `"auto"`, `"lex"`, or `"sem"` |
+| `model` | `string` | LLM for synthesis (e.g., `"openai:gpt-4o-mini"`) |
+| `modelApiKey` | `string` | API key for the LLM provider |
+| `contextOnly` | `boolean` | Skip synthesis, return context only |
+| `returnSources` | `boolean` | Include source metadata in response |
+
+### Timeline queries
+
+```typescript
+const entries = await mv.timeline({
+  limit: 50,
+  since: 1704067200,  // Unix timestamp
+  reverse: true,
+});
+```
+
+### Statistics
+
+```typescript
+const stats = await mv.stats();
+// { frameCount, sizeBytes, hasLexIndex, hasVecIndex, ... }
+```
+
+### File operations
+
+```typescript
+// Commit pending changes
+await mv.seal();
+
+// Verify file integrity
+import { verifyMemvid } from "@memvid/sdk";
+const report = await verifyMemvid("notes.mv2", { deep: true });
+
+// Repair indexes
+import { doctorMemvid } from "@memvid/sdk";
+await doctorMemvid("notes.mv2", { rebuildLexIndex: true });
+```
+
+## Framework adapters
+
+Adapters expose framework-native tools when the corresponding dependency is installed.
+
+### LangChain
+
+```typescript
+import { use } from "@memvid/sdk";
+
+const mv = await use("langchain", "notes.mv2");
+const tools = mv.tools; // StructuredTool instances for put/find/ask
+```
+
+### LlamaIndex
+
+```typescript
+const mv = await use("llamaindex", "notes.mv2");
+const queryEngine = mv.asQueryEngine();
+```
+
+### OpenAI function calling
+
+```typescript
+const mv = await use("openai", "notes.mv2");
+const functions = mv.functions; // JSON schemas for tool_calls
+```
+
+### Vercel AI SDK
+
+```typescript
+const mv = await use("vercel-ai", "notes.mv2");
+```
+
+## Table extraction
+
+Extract structured tables from PDFs:
+
+```typescript
+const result = await mv.putPdfTables("report.pdf", { embedRows: true });
+console.log(`Extracted ${result.tablesCount} tables`);
+
+const tables = await mv.listTables();
+const data = await mv.getTable(tables[0].tableId, { format: "json" });
+```
+
+## Error handling
+
+Errors include a code prefix for programmatic handling:
+
+| Code | Description |
+|------|-------------|
+| `MV001` | Storage capacity exceeded |
+| `MV002` | Invalid ticket signature |
+| `MV003` | Ticket replay detected |
+| `MV004` | Lexical index not enabled |
+| `MV005` | Time index missing |
+| `MV006` | Verification failed |
+| `MV007` | File locked by another process |
+
+```typescript
+try {
+  await mv.put({ ... });
+} catch (err) {
+  if (err.message.startsWith("MV001")) {
+    console.error("Out of storage capacity");
+  }
+}
+```
+
+## Environment variables
+
+| Variable | Description |
+|----------|-------------|
+| `MEMVID_API_KEY` | API key for capacity beyond free tier |
+| `MEMVID_API_URL` | Control plane URL (for enterprise deployments) |
+| `MEMVID_MODELS_DIR` | Path to embedding model cache |
+
+## Building from source
+
+```bash
+# Install dependencies
+pnpm install
+
+# Build TypeScript
+pnpm run build
+
+# Build native module (requires Rust toolchain)
+cargo build --release
+cp target/release/libmemvid_node.dylib index.node  # macOS
+```
+
+## Requirements
+
+- Node.js 18+
+- macOS (Apple Silicon or Intel), Linux (x64), or Windows (x64)
+
+## License
+
+Apache-2.0. See [LICENSE](./LICENSE).

package/dist/__tests__/basic.test.d.ts

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

package/dist/__tests__/basic.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 node_test_1 = require("node:test");
+const strict_1 = __importDefault(require("node:assert/strict"));
+const node_fs_1 = require("node:fs");
+const node_path_1 = require("node:path");
+const node_os_1 = require("node:os");
+const index_1 = require("../index");
+function tempPath(name) {
+    const dir = (0, node_fs_1.mkdtempSync)((0, node_path_1.join)((0, node_os_1.tmpdir)(), "memvid-sdk-node-"));
+    return { dir, file: (0, node_path_1.join)(dir, name) };
+}
+(0, node_test_1.test)("basic use() workflow", async (t) => {
+    const { dir, file } = tempPath("basic.mv2");
+    const mv = await (0, index_1.create)(file);
+    const frameId = await mv.put({
+        title: "hello",
+        label: "note",
+        metadata: { topic: "demo" },
+        text: "hello world",
+    });
+    strict_1.default.ok(frameId);
+    const stats = await mv.stats();
+    strict_1.default.equal(stats.frame_count, 1);
+    const results = (await mv.find("hello", { k: 1 }));
+    strict_1.default.ok(Array.isArray(results.hits));
+    strict_1.default.equal(results.hits.length, 1);
+    await strict_1.default.rejects(() => mv.applyTicket("{}"), /MV002/);
+    await strict_1.default.rejects(() => mv.ask("llm", { model: "unsupported", modelApiKey: "key" }), /unsupported model/);
+    await mv.seal();
+    const reopened = await (0, index_1.use)("basic", file);
+    const reopenedStats = await reopened.stats();
+    strict_1.default.equal(reopenedStats.frame_count, 1);
+    await reopened.seal();
+    t.after(() => {
+        (0, node_fs_1.rmSync)(dir, { recursive: true, force: true });
+    });
+});

package/dist/adapters/autogen.d.ts

@@ -0,0 +1,23 @@
+/**
+ * AutoGen adapter exposing Memvid core methods as AutoGen-compatible tools.
+ *
+ * AutoGen (Microsoft) uses a function-based tool pattern compatible with
+ * OpenAI's function calling API. This adapter provides three tools:
+ * - memvid_put: Store documents in memory
+ * - memvid_find: Search for relevant documents
+ * - memvid_ask: Query with RAG-style answer synthesis
+ *
+ * Usage:
+ *    import { use } from "memvid-sdk";
+ *
+ *    const mem = await use("autogen", "knowledge.mv2");
+ *
+ *    // Access tools for AutoGen agents
+ *    const tools = mem.tools; // Array of tool definitions
+ *
+ *    // Tools follow OpenAI function calling format and can be used with
+ *    // AutoGen's AssistantAgent or any OpenAI-compatible agent framework
+ *
+ * Note: AutoGen for Node.js uses OpenAI-compatible tool definitions.
+ */
+export {};

package/dist/adapters/autogen.js

@@ -0,0 +1,163 @@
+"use strict";
+/**
+ * AutoGen adapter exposing Memvid core methods as AutoGen-compatible tools.
+ *
+ * AutoGen (Microsoft) uses a function-based tool pattern compatible with
+ * OpenAI's function calling API. This adapter provides three tools:
+ * - memvid_put: Store documents in memory
+ * - memvid_find: Search for relevant documents
+ * - memvid_ask: Query with RAG-style answer synthesis
+ *
+ * Usage:
+ *    import { use } from "memvid-sdk";
+ *
+ *    const mem = await use("autogen", "knowledge.mv2");
+ *
+ *    // Access tools for AutoGen agents
+ *    const tools = mem.tools; // Array of tool definitions
+ *
+ *    // Tools follow OpenAI function calling format and can be used with
+ *    // AutoGen's AssistantAgent or any OpenAI-compatible agent framework
+ *
+ * Note: AutoGen for Node.js uses OpenAI-compatible tool definitions.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+const noop_1 = require("../noop");
+const registry_1 = require("../registry");
+const KIND = "autogen";
+(0, registry_1.register)(KIND, async (core, _apiKey) => {
+    // AutoGen uses OpenAI-compatible function definitions
+    // We provide both the schema and the callable implementation
+    // Define the memvid_put tool
+    const memvidPutTool = {
+        type: "function",
+        function: {
+            name: "memvid_put",
+            description: "Store a document in Memvid memory for later retrieval.",
+            parameters: {
+                type: "object",
+                properties: {
+                    title: {
+                        type: "string",
+                        description: "Title of the document",
+                    },
+                    label: {
+                        type: "string",
+                        description: "Category or label for the document",
+                    },
+                    text: {
+                        type: "string",
+                        description: "Text content to store",
+                    },
+                    metadata: {
+                        type: "object",
+                        description: "Optional key-value metadata",
+                        additionalProperties: true,
+                    },
+                },
+                required: ["title", "label", "text"],
+            },
+        },
+        callable: async (args) => {
+            const frameId = await core.put({
+                title: args.title,
+                label: args.label,
+                text: args.text,
+                metadata: args.metadata ?? {},
+                enable_embedding: true,
+                auto_tag: true,
+                extract_dates: true,
+            });
+            return `Document stored with frame_id: ${frameId}`;
+        },
+    };
+    // Define the memvid_find tool
+    const memvidFindTool = {
+        type: "function",
+        function: {
+            name: "memvid_find",
+            description: "Search Memvid memory for documents matching a query.",
+            parameters: {
+                type: "object",
+                properties: {
+                    query: {
+                        type: "string",
+                        description: "Search query string",
+                    },
+                    top_k: {
+                        type: "number",
+                        description: "Number of results to return (default: 5)",
+                    },
+                },
+                required: ["query"],
+            },
+        },
+        callable: async (args) => {
+            const query = args.query;
+            const topK = args.top_k ?? 5;
+            const response = (await core.find(query, { k: topK }));
+            const hits = response.hits ?? [];
+            if (hits.length === 0) {
+                return `No results found for query: '${query}'`;
+            }
+            const results = [];
+            for (let i = 0; i < hits.length; i++) {
+                const hit = hits[i];
+                const title = hit.title ?? "Untitled";
+                const snippet = (hit.text ?? hit.snippet ?? "").slice(0, 200);
+                const score = hit.score ?? 0;
+                results.push(`${i + 1}. [${title}] (score: ${score.toFixed(2)}): ${snippet}...`);
+            }
+            return `Found ${hits.length} results:\n${results.join("\n")}`;
+        },
+    };
+    // Define the memvid_ask tool
+    const memvidAskTool = {
+        type: "function",
+        function: {
+            name: "memvid_ask",
+            description: "Ask a question and get an answer synthesized from Memvid memory.",
+            parameters: {
+                type: "object",
+                properties: {
+                    question: {
+                        type: "string",
+                        description: "Question to answer",
+                    },
+                    mode: {
+                        type: "string",
+                        description: "Search mode: 'auto', 'lex', or 'sem'",
+                        enum: ["auto", "lex", "sem"],
+                    },
+                },
+                required: ["question"],
+            },
+        },
+        callable: async (args) => {
+            const question = args.question;
+            const mode = args.mode ?? "auto";
+            const response = (await core.ask(question, { mode }));
+            const answer = response.answer ?? "No answer generated";
+            const sources = response.sources ?? [];
+            let result = `Answer: ${answer}`;
+            if (sources.length > 0) {
+                const sourceTitles = sources.slice(0, 3).map((s) => s.title ?? "Unknown");
+                result += `\n\nSources: ${sourceTitles.join(", ")}`;
+            }
+            return result;
+        },
+    };
+    const tools = [memvidPutTool, memvidFindTool, memvidAskTool];
+    // Also expose the raw functions for direct use
+    const functions = [
+        memvidPutTool.callable,
+        memvidFindTool.callable,
+        memvidAskTool.callable,
+    ];
+    return {
+        tools,
+        functions,
+        nodes: (0, noop_1.createNoOp)("autogen adapter nodes not provided", "memvid.adapters.autogen.nodes"),
+        asQueryEngine: null,
+    };
+});

package/dist/adapters/basic.d.ts

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

package/dist/adapters/basic.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const noop_1 = require("../noop");
+const registry_1 = require("../registry");
+const KIND = "basic";
+(0, registry_1.register)(KIND, async () => ({
+    tools: (0, noop_1.createNoOp)("basic kind exposes no tools", "memvid.adapters.basic.tools"),
+    functions: [],
+    nodes: (0, noop_1.createNoOp)("basic kind exposes no nodes", "memvid.adapters.basic.nodes"),
+    asQueryEngine: null,
+}));