@memvid/sdk 2.0.113

package/dist/types.d.ts

@@ -0,0 +1,275 @@
+export type Kind = "basic" | "langchain" | "llamaindex" | "crewai" | "vercel-ai" | "openai" | "autogen" | "haystack" | "langgraph" | "semantic-kernel" | "google-adk" | "mcp";
+export type ApiKey = string | {
+    provider: string;
+    key: string;
+} | Record<string, string>;
+export type ApiKeyMap = Record<string, string>;
+export type MemvidErrorCode = "MV001" | "MV002" | "MV003" | "MV004" | "MV005" | "MV006" | "MV007" | "MV008" | "MV009" | "MV010" | "MV011" | "MV012" | "MV999";
+export interface MemvidErrorDetails {
+    code: MemvidErrorCode;
+    message: string;
+    details?: Record<string, unknown>;
+}
+export interface AdapterBundle {
+    tools: unknown;
+    functions: unknown;
+    nodes: unknown;
+    asQueryEngine?: (() => unknown) | null;
+}
+export interface PutInput {
+    title: string;
+    label: string;
+    metadata?: Record<string, unknown>;
+    text?: string;
+    file?: string;
+    uri?: string;
+    tags?: string[];
+    labels?: string[];
+    kind?: string;
+    track?: string;
+    searchText?: string;
+    enableEmbedding?: boolean;
+    autoTag?: boolean;
+    extractDates?: boolean;
+    vectorCompression?: boolean;
+}
+export interface FindInput {
+    k?: number;
+    snippetChars?: number;
+    scope?: string;
+    cursor?: string;
+    asOfFrame?: number;
+    asOfTs?: number;
+}
+export interface AskInput {
+    k?: number;
+    mode?: string;
+    snippetChars?: number;
+    scope?: string;
+    since?: number;
+    until?: number;
+    contextOnly?: boolean;
+    model?: string;
+    llmContextChars?: number;
+    modelApiKey?: string;
+    maskPii?: boolean;
+    asOfFrame?: number;
+    asOfTs?: number;
+}
+export interface TimelineInput {
+    limit?: number;
+    since?: number;
+    until?: number;
+    reverse?: boolean;
+    asOfFrame?: number;
+    asOfTs?: number;
+}
+/** A single document for batch ingestion via putMany */
+export interface PutManyInput {
+    /** Document title (required) */
+    title: string;
+    /** Document text content (required) */
+    text: string;
+    /** Optional URI for the document */
+    uri?: string;
+    /** Optional labels for classification */
+    labels?: string[];
+    /** Optional tags for tagging */
+    tags?: string[];
+    /** Optional metadata */
+    metadata?: Record<string, unknown>;
+    /** Optional pre-computed embedding vector */
+    embedding?: number[];
+}
+/** Options for putMany batch ingestion */
+export interface PutManyOptions {
+    /** Zstd compression level (0-11, default: 3) */
+    compressionLevel?: number;
+}
+/** Native putMany request format */
+export interface NativePutManyRequest {
+    title: string;
+    text: string;
+    uri?: string;
+    labels?: string[];
+    tags?: string[];
+    metadata?: Record<string, unknown>;
+    embedding?: number[];
+}
+/** Native putMany options format */
+export interface NativePutManyOptions {
+    compression_level?: number;
+}
+export interface NativePutArgs {
+    title: string;
+    label: string;
+    metadata?: unknown;
+    text?: string;
+    file?: string;
+    uri?: string;
+    tags?: string[];
+    labels?: string[];
+    kind?: string;
+    track?: string;
+    search_text?: string;
+    enable_embedding?: boolean;
+    auto_tag?: boolean;
+    extract_dates?: boolean;
+    vector_compression?: boolean;
+}
+export interface NativeFindOptions {
+    k?: number;
+    snippetChars?: number;
+    scope?: string;
+    cursor?: string;
+    asOfFrame?: number;
+    asOfTs?: number;
+}
+export interface NativeAskOptions {
+    k?: number;
+    mode?: string;
+    snippetChars?: number;
+    scope?: string;
+    since?: number;
+    until?: number;
+    contextOnly?: boolean;
+    model?: string;
+    llmContextChars?: number;
+    modelApiKey?: string;
+    asOfFrame?: number;
+    asOfTs?: number;
+}
+export interface NativeTimelineOptions {
+    limit?: number;
+    since?: number;
+    until?: number;
+    reverse?: boolean;
+    asOfFrame?: number;
+    asOfTs?: number;
+}
+export interface TableInfo {
+    table_id: string;
+    n_rows: number;
+    n_cols: number;
+    headers?: string[];
+    detection_mode?: string;
+    quality?: string;
+    page_start?: number;
+    page_end?: number;
+    source_file?: string;
+}
+export interface TableExtractionResult {
+    tables_count: number;
+    tables: TableInfo[];
+}
+export interface TableData {
+    headers?: string[];
+    rows?: unknown[][];
+}
+export interface NativeMemvid {
+    put(args: NativePutArgs): Promise<string>;
+    putMany(requests: NativePutManyRequest[], options?: NativePutManyOptions): Promise<string[]>;
+    find(query: string, options?: NativeFindOptions): Promise<unknown>;
+    ask(question: string, options?: NativeAskOptions): Promise<unknown>;
+    stats(): Promise<Record<string, unknown>>;
+    timeline(options?: NativeTimelineOptions): Promise<unknown>;
+    seal(): Promise<void>;
+    enableLex(): Promise<void>;
+    setVectorCompression(enabled: boolean): Promise<void>;
+    applyTicket(ticket: string): Promise<void>;
+    getMemoryBinding(): Promise<MemoryBinding | null>;
+    unbindMemory(): Promise<void>;
+    getCapacity(): Promise<number>;
+    currentTicket(): Promise<TicketInfo>;
+    syncTickets(memoryId: string, apiKey: string, apiUrl?: string): Promise<SyncTicketResult>;
+    putPdfTables(pdfPath: string, embedRows?: boolean): Promise<TableExtractionResult>;
+    listTables(): Promise<TableInfo[]>;
+    getTable(tableId: string, format?: string): Promise<TableData | string>;
+}
+export interface MemoryBinding {
+    memory_id: string;
+    memory_name: string;
+    bound_at: string;
+    api_url: string;
+}
+export interface TicketInfo {
+    issuer: string;
+    seq_no: number;
+    expires_in_secs: number;
+    capacity_bytes: number;
+}
+export interface SyncTicketResult {
+    already_bound: boolean;
+    memory_id: string;
+    issuer: string;
+    seq_no: number;
+    capacity_bytes: number;
+}
+export interface HeatmapEntry {
+    frame_id: number;
+    hit_count: number;
+    preview?: string;
+}
+export interface HeatmapResponse {
+    total_frames: number;
+    total_accesses: number;
+    entries: HeatmapEntry[];
+}
+export interface Memvid {
+    put(data: PutInput): Promise<string>;
+    /**
+     * Batch ingest multiple documents using parallel segment building.
+     * Much more efficient than calling put() multiple times.
+     * Returns an array of frame IDs for the ingested documents.
+     */
+    putMany(requests: PutManyInput[], options?: PutManyOptions): Promise<string[]>;
+    find(query: string, opts?: FindInput): Promise<any>;
+    ask(question: string, opts?: AskInput): Promise<any>;
+    timeline(opts?: TimelineInput): Promise<any>;
+    stats(): Promise<Record<string, unknown>>;
+    seal(): Promise<void>;
+    enableLex(): Promise<void>;
+    setVectorCompression(enabled: boolean): Promise<void>;
+    applyTicket(ticket: string): Promise<void>;
+    getMemoryBinding(): Promise<MemoryBinding | null>;
+    unbindMemory(): Promise<void>;
+    getCapacity(): Promise<number>;
+    currentTicket(): Promise<TicketInfo>;
+    syncTickets(memoryId: string, apiKey: string, apiUrl?: string): Promise<SyncTicketResult>;
+    putPdfTables(pdfPath: string, embedRows?: boolean): Promise<TableExtractionResult>;
+    listTables(): Promise<TableInfo[]>;
+    getTable(tableId: string, format?: string): Promise<TableData | string>;
+    tools: unknown;
+    functions: unknown;
+    nodes: unknown;
+    asQueryEngine?: (() => unknown) | null;
+}
+export interface UseVerifyOptions {
+    deep?: boolean;
+}
+export interface UseDoctorOptions {
+    rebuildTimeIndex?: boolean;
+    rebuildLexIndex?: boolean;
+    rebuildVecIndex?: boolean;
+    vacuum?: boolean;
+    dryRun?: boolean;
+}
+export interface UseOptions {
+    mode?: "open" | "create" | "auto";
+}
+export type NativeVerifyOptions = {
+    deep?: boolean;
+};
+export type NativeDoctorOptions = {
+    rebuild_time_index?: boolean;
+    rebuild_lex_index?: boolean;
+    rebuild_vec_index?: boolean;
+    vacuum?: boolean;
+    dry_run?: boolean;
+};
+export interface NativeAddon {
+    openMemvid(path: string, mode?: string, enableLex?: boolean, enableVec?: boolean, apiKey?: string): NativeMemvid;
+    verifyMemvid(path: string, options?: NativeVerifyOptions): Promise<unknown>;
+    doctorMemvid(path: string, options?: NativeDoctorOptions): Promise<unknown>;
+    maskPii(text: string): string;
+}

package/dist/types.js

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

package/package.json

@@ -0,0 +1,81 @@
+{
+  "name": "@memvid/sdk",
+  "version": "2.0.113",
+  "description": "Single-file AI memory system for Node.js. Store, search, and query documents with built-in RAG.",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "require": "./dist/index.js",
+      "import": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist/**/*",
+    "index.node"
+  ],
+  "scripts": {
+    "build": "tsc -p tsconfig.json",
+    "lint": "tsc -p tsconfig.json --noEmit"
+  },
+  "license": "Apache-2.0",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/memvid-ai/memvid"
+  },
+  "homepage": "https://memvid.com",
+  "keywords": [
+    "ai",
+    "memory",
+    "rag",
+    "vector-search",
+    "semantic-search",
+    "langchain",
+    "llamaindex",
+    "openai",
+    "embeddings"
+  ],
+  "engines": {
+    "node": ">=18"
+  },
+  "peerDependencies": {
+    "@langchain/core": ">=0.3.0",
+    "ai": ">=4.0.0",
+    "llamaindex": ">=0.12.0",
+    "openai": ">=1.0.0",
+    "zod": "^3.0.0"
+  },
+  "peerDependenciesMeta": {
+    "@langchain/core": {
+      "optional": true
+    },
+    "ai": {
+      "optional": true
+    },
+    "llamaindex": {
+      "optional": true
+    },
+    "openai": {
+      "optional": true
+    },
+    "zod": {
+      "optional": true
+    }
+  },
+  "devDependencies": {
+    "@types/node": "^20.12.7",
+    "ts-node": "^10.9.0",
+    "typescript": "^5.4.0"
+  },
+  "dependencies": {
+    "@ai-sdk/openai": "^1.0.0",
+    "@google/generative-ai": "^0.24.0",
+    "@langchain/langgraph": ">=0.2.0",
+    "@langchain/openai": ">=0.3.0",
+    "@llamaindex/core": ">=0.4.0",
+    "@llamaindex/openai": ">=0.2.0",
+    "ai": ">=4.0.0",
+    "langchain": ">=0.3.0",
+    "llamaindex": ">=0.12.0"
+  }
+}