mimir-memory 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Arjun Subburaj
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,66 @@
+# mimir-memory (npm)
+
+> TypeScript/JavaScript SDK for the [Mimir](https://github.com/junainfinity/Mimir) agentic memory system.
+
+## Prerequisites
+
+Mimir's Python server must be running:
+
+```bash
+pip install mimir-memory[server]
+mimir-server              # starts on http://localhost:8484
+```
+
+## Install
+
+```bash
+npm install mimir-memory
+```
+
+## Usage
+
+```typescript
+import { Mimir } from "mimir-memory";
+
+const mimir = new Mimir(); // defaults to http://localhost:8484
+
+// Archive a fact
+await mimir.archive({
+  content: "John lives in London",
+  source: "user",
+  relation: "lives_in",
+  target: "London",
+  scope: "user",
+});
+
+// Search memory
+const result = await mimir.search({ query: "Where does John live?" });
+console.log(result);
+// { result: "Found Context:\n- [... → Present]: user --(lives_in)--> London" }
+
+// Temporal query
+const past = await mimir.search({
+  query: "Where did John live?",
+  timestamp: "2026-01-01T00:00:00",
+});
+
+// Health check
+const health = await mimir.health();
+console.log(health); // { status: "ok", version: "0.1.0" }
+```
+
+## API
+
+### `new Mimir(options?)`
+| Option | Type | Default | Description |
+|--------|------|---------|-------------|
+| `baseUrl` | `string` | `http://localhost:8484` | Mimir server URL |
+
+### `mimir.archive(params)`
+Archive a fact into bitemporal memory.
+
+### `mimir.search(params)`
+Search memory with optional temporal filtering.
+
+### `mimir.health()`
+Check server status.

package/dist/index.d.ts

@@ -0,0 +1,75 @@
+/**
+ * Mimir Memory SDK
+ *
+ * TypeScript/JavaScript client for the Mimir agentic memory REST API.
+ *
+ * @example
+ * ```ts
+ * import { Mimir } from "mimir-memory";
+ *
+ * const mimir = new Mimir();  // defaults to http://localhost:8484
+ *
+ * await mimir.archive({
+ *   content: "John lives in London",
+ *   source: "user",
+ *   relation: "lives_in",
+ *   target: "London",
+ *   scope: "user",
+ * });
+ *
+ * const results = await mimir.search({ query: "Where does John live?" });
+ * console.log(results);
+ * ```
+ */
+export interface MimirOptions {
+    /** Base URL of the Mimir REST server. Defaults to `http://localhost:8484`. */
+    baseUrl?: string;
+}
+export interface ArchiveParams {
+    /** Raw text content to embed and store. */
+    content: string;
+    /** Source entity (e.g. "user"). */
+    source: string;
+    /** Relationship type (e.g. "lives_in"). */
+    relation: string;
+    /** Target entity (e.g. "London"). */
+    target: string;
+    /** Scope tag: "user", "session", or "system". Defaults to "user". */
+    scope?: string;
+}
+export interface SearchParams {
+    /** Natural language search query. */
+    query: string;
+    /** Optional ISO timestamp for temporal queries. */
+    timestamp?: string;
+}
+export interface MemoryResponse {
+    result: string;
+}
+export interface HealthResponse {
+    status: string;
+    version: string;
+}
+export declare class Mimir {
+    private baseUrl;
+    constructor(options?: MimirOptions);
+    private request;
+    /**
+     * Check if the Mimir server is reachable.
+     */
+    health(): Promise<HealthResponse>;
+    /**
+     * Archive a new fact into Mimir's bitemporal memory.
+     *
+     * The content is embedded via the server's local embedding model,
+     * stored in Zvec, and a bitemporal edge is created in SQLite.
+     */
+    archive(params: ArchiveParams): Promise<MemoryResponse>;
+    /**
+     * Search Mimir's memory with a natural language query.
+     *
+     * Optionally pass a `timestamp` to retrieve facts valid at that point in time.
+     */
+    search(params: SearchParams): Promise<MemoryResponse>;
+}
+export default Mimir;

package/dist/index.js

@@ -0,0 +1,85 @@
+"use strict";
+/**
+ * Mimir Memory SDK
+ *
+ * TypeScript/JavaScript client for the Mimir agentic memory REST API.
+ *
+ * @example
+ * ```ts
+ * import { Mimir } from "mimir-memory";
+ *
+ * const mimir = new Mimir();  // defaults to http://localhost:8484
+ *
+ * await mimir.archive({
+ *   content: "John lives in London",
+ *   source: "user",
+ *   relation: "lives_in",
+ *   target: "London",
+ *   scope: "user",
+ * });
+ *
+ * const results = await mimir.search({ query: "Where does John live?" });
+ * console.log(results);
+ * ```
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Mimir = void 0;
+// ── Client ──────────────────────────────────────────────────────────────
+class Mimir {
+    constructor(options = {}) {
+        this.baseUrl = (options.baseUrl || "http://localhost:8484").replace(/\/$/, "");
+    }
+    // -- helpers --
+    async request(path, method, body) {
+        const url = `${this.baseUrl}${path}`;
+        const init = {
+            method,
+            headers: { "Content-Type": "application/json" },
+        };
+        if (body !== undefined) {
+            init.body = JSON.stringify(body);
+        }
+        const res = await fetch(url, init);
+        if (!res.ok) {
+            const text = await res.text();
+            throw new Error(`Mimir API error ${res.status}: ${text}`);
+        }
+        return (await res.json());
+    }
+    // -- public API --
+    /**
+     * Check if the Mimir server is reachable.
+     */
+    async health() {
+        return this.request("/health", "GET");
+    }
+    /**
+     * Archive a new fact into Mimir's bitemporal memory.
+     *
+     * The content is embedded via the server's local embedding model,
+     * stored in Zvec, and a bitemporal edge is created in SQLite.
+     */
+    async archive(params) {
+        return this.request("/archive", "POST", {
+            content: params.content,
+            source: params.source,
+            relation: params.relation,
+            target: params.target,
+            scope: params.scope ?? "user",
+        });
+    }
+    /**
+     * Search Mimir's memory with a natural language query.
+     *
+     * Optionally pass a `timestamp` to retrieve facts valid at that point in time.
+     */
+    async search(params) {
+        const body = { query: params.query };
+        if (params.timestamp) {
+            body.timestamp = params.timestamp;
+        }
+        return this.request("/search", "POST", body);
+    }
+}
+exports.Mimir = Mimir;
+exports.default = Mimir;

package/package.json

@@ -0,0 +1,33 @@
+{
+    "name": "mimir-memory",
+    "version": "0.1.0",
+    "description": "TypeScript/JavaScript SDK for the Mimir agentic memory system — archive and search with bitemporal guarantees",
+    "main": "dist/index.js",
+    "types": "dist/index.d.ts",
+    "files": [
+        "dist/",
+        "README.md",
+        "LICENSE"
+    ],
+    "keywords": [
+        "llm",
+        "memory",
+        "agent",
+        "vector-search",
+        "bitemporal",
+        "ai"
+    ],
+    "author": "Arjun Subburaj",
+    "license": "MIT",
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/junainfinity/Mimir"
+    },
+    "scripts": {
+        "build": "tsc",
+        "prepublishOnly": "npm run build"
+    },
+    "devDependencies": {
+        "typescript": "^5.7.0"
+    }
+}