convex-supermemory 0.0.1

package/LICENSE

@@ -0,0 +1,201 @@
+                                 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 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
+
+APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+Copyright [yyyy] [name of copyright owner]
+
+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,306 @@
+# convex-supermemory
+
+**Give your Convex app long-term, semantically searchable memory with Supermemory.** Reactive local memory and document state, direct REST integration.
+
+[![npm version](https://img.shields.io/npm/v/convex-supermemory)](https://www.npmjs.com/package/convex-supermemory)
+[![Convex Component](https://www.convex.dev/components/badge/sholajegede/convex-supermemory)](https://www.convex.dev/components/sholajegede/convex-supermemory)
+[![npm downloads](https://img.shields.io/npm/dw/convex-supermemory)](https://www.npmjs.com/package/convex-supermemory)
+[![License](https://img.shields.io/badge/license-Apache--2.0-blue)](./LICENSE)
+
+```ts
+const supermemory = new Supermemory(components.convexSupermemory, {
+  apiKey: process.env.SUPERMEMORY_API_KEY!,
+});
+
+// Store a fact about a user
+const { memoryId } = await supermemory.addMemory(ctx, {
+  containerTag: userId,
+  content: "Prefers dark mode and terse responses",
+});
+
+// Recall it later with semantic search
+const { results } = await supermemory.search({
+  containerTag: userId,
+  query: "how does this user like responses formatted?",
+});
+```
+
+## What this does
+
+An AI agent is only as good as what it remembers between calls. [Supermemory](https://supermemory.ai) is a memory API purpose-built for this: you write facts and documents into a `containerTag` (typically one per user or agent), and it handles embedding, chunking, and semantic search so you can recall the right context later — without you running your own vector database.
+
+This component wraps Supermemory's REST API directly (no SDK dependency) and mirrors everything you write into Convex tables, so you get:
+
+- **Fast-path memory** — `addMemory()` stores a single fact immediately, no processing pipeline
+- **Document ingestion** — `addDocument()` sends larger content through Supermemory's extraction/chunking pipeline, with `refreshDocument()` to poll status
+- **Semantic search** — `search()` proxies Supermemory's hybrid RAG + memory search live
+- **Reactive local state** — every memory and document is queryable from Convex without an extra API call
+- **Forgetting** — `forgetMemory()` / `deleteDocument()` keep local state in sync with what Supermemory actually removes
+
+## Table of Contents
+
+- [Install](#install)
+- [Quick Start](#quick-start)
+- [Usage](#usage)
+- [Memories vs. Documents](#memories-vs-documents)
+- [API Reference](#api-reference)
+- [Type Reference](#type-reference)
+- [Database Schema](#database-schema)
+- [Container Tags](#container-tags)
+- [Testing](#testing)
+- [Example App](#example-app)
+- [Limitations](#limitations)
+- [Troubleshooting](#troubleshooting)
+- [Contributing](#contributing)
+- [Changelog](#changelog)
+
+## Install
+
+```bash
+npm install convex-supermemory
+```
+
+**Requirements:** Convex v1.33.1 or later, Node.js 18+, a [Supermemory](https://supermemory.ai) API key
+
+## Quick Start
+
+Three steps to add memory to your Convex app.
+
+### 1. Add the component
+
+In `convex/convex.config.ts`:
+
+```ts
+import { defineApp } from "convex/server";
+import convexSupermemory from "convex-supermemory/convex.config";
+
+const app = defineApp();
+app.use(convexSupermemory);
+
+export default app;
+```
+
+### 2. Set environment variables
+
+```bash
+npx convex env set SUPERMEMORY_API_KEY sm_xxxxxxxxxxxx
+```
+
+### 3. Initialize the client
+
+In `convex/memory.ts`:
+
+```ts
+import { components } from "./_generated/api";
+import { Supermemory } from "convex-supermemory";
+
+export const supermemory = new Supermemory(components.convexSupermemory, {
+  apiKey: process.env.SUPERMEMORY_API_KEY!,
+});
+```
+
+Import `supermemory` from this file in any Convex action that needs to read or write memory.
+
+## Usage
+
+### Remember a fact
+
+```ts
+export const remember = action({
+  args: { userId: v.string(), fact: v.string() },
+  handler: async (ctx, args) => {
+    return await supermemory.addMemory(ctx, {
+      containerTag: args.userId,
+      content: args.fact,
+      isStatic: true, // long-term fact, not a fading conversational detail
+    });
+  },
+});
+// Returns: { memoryId }
+```
+
+### Recall with semantic search
+
+```ts
+export const recall = action({
+  args: { userId: v.string(), query: v.string() },
+  handler: async (ctx, args) => {
+    return await supermemory.search({
+      containerTag: args.userId,
+      query: args.query,
+      limit: 5,
+    });
+  },
+});
+// Returns: { results: [{ documentId, score, summary, chunks, ... }], total }
+```
+
+### Forget a memory
+
+`containerTag` is required here too — Supermemory scopes the delete by it, not just by `memoryId`.
+
+```ts
+export const forget = action({
+  args: { userId: v.string(), memoryId: v.string() },
+  handler: async (ctx, args) => {
+    return await supermemory.forgetMemory(ctx, {
+      containerTag: args.userId,
+      memoryId: args.memoryId,
+    });
+  },
+});
+// Returns: { forgotten: boolean }
+```
+
+### List a user's memories reactively
+
+```ts
+export const getMemories = query({
+  args: { userId: v.string() },
+  handler: async (ctx, args) => {
+    return await supermemory.listMemories(ctx, { containerTag: args.userId });
+  },
+});
+```
+
+## Memories vs. Documents
+
+Supermemory exposes two ways to write content, and this component exposes both:
+
+- **`addMemory()`** — for short, discrete facts ("the user is on the Pro plan", "prefers metric units"). No processing delay; usable in search immediately.
+- **`addDocument()`** — for longer content (a support transcript, a page of documentation, a whole conversation) that needs to be chunked and embedded. Processing is asynchronous — call `refreshDocument()` to check on `status` (`queued` → `extracting` → `chunking` → `embedding` → `indexing` → `done`).
+
+## API Reference
+
+| Method | Kind | Description |
+| --- | --- | --- |
+| `addMemory(ctx, args)` | action | Stores a single fact immediately |
+| `forgetMemory(ctx, args)` | action | Requests Supermemory forget a memory (scoped by `containerTag`) |
+| `addDocument(ctx, args)` | action | Ingests larger content through the chunking pipeline |
+| `refreshDocument(ctx, args)` | action | Pulls the latest status/title/summary for a document |
+| `deleteDocument(ctx, args)` | action | Deletes a document from Supermemory and locally |
+| `search(args)` | plain async | Live semantic search — not cached locally |
+| `getMemory(ctx, args)` | query | Fetch one memory by id |
+| `listMemories(ctx, args)` | query | List a container's memories, newest first |
+| `getDocument(ctx, args)` | query | Fetch one document by id |
+| `listDocuments(ctx, args)` | query | List a container's documents, newest first |
+| `getStats(ctx)` | query | Aggregate memory/document counts for a small dashboard |
+| `listRecentMemories(ctx, args?)` | query | Every memory, newest first, regardless of containerTag |
+| `listRecentDocuments(ctx, args?)` | query | Every document, newest first, regardless of containerTag |
+
+## Type Reference
+
+```ts
+type AddMemoryArgs = {
+  containerTag: string;
+  content: string;
+  isStatic?: boolean;
+  metadata?: Record<string, unknown>;
+  forgetAfter?: number;   // ms epoch
+  forgetReason?: string;
+};
+
+type AddDocumentArgs = {
+  containerTag: string;
+  content: string;
+  customId?: string;
+  metadata?: Record<string, unknown>;
+};
+
+type SearchArgs = {
+  containerTag: string;
+  query: string;
+  limit?: number;
+  rerank?: boolean;
+  includeFullDocs?: boolean;
+};
+
+type SearchResponse = {
+  results: Array<{
+    documentId: string;
+    title: string | null;
+    score: number;
+    summary: string | null;
+    content: string | null;
+    chunks: Array<{ content: string; score: number; position: number; isRelevant: boolean }>;
+  }>;
+  total: number;
+  timing?: number; // ms, when Supermemory reports it
+};
+```
+
+## Database Schema
+
+```ts
+memories: {
+  memoryId, containerTag, content, isStatic, metadata?,
+  forgetAfter?, forgetReason?, forgotten,
+  createdAt, updatedAt,
+}
+
+documents: {
+  documentId, containerTag, content?, customId?, metadata?, status,
+  title?, summary?,
+  createdAt, updatedAt,
+}
+```
+
+`getStats()`, `listRecentMemories()`, and `listRecentDocuments()` read across these tables directly with a full scan — fine for a dashboard or history view, not intended as a high-volume production query path.
+
+## Container Tags
+
+Supermemory scopes everything — writes, search, and profiles — by `containerTag`. Use one per user for personal memory, or one per agent/workspace for shared memory. Search only ever looks within the container tag you pass, so pick a convention early (this component doesn't enforce one).
+
+## Testing
+
+```bash
+npm run test
+```
+
+Component logic is tested with [`convex-test`](https://www.npmjs.com/package/convex-test) in `src/component/lib.test.ts`. Import `convex-supermemory/test` in your own app to register this component's schema against your test instance.
+
+## Example App
+
+`example/` is a full Vite + React demo that exercises the entire component end to end against your own Supermemory account:
+
+- **Memories** — add a fact with `addMemory()` (with suggestion chips to try), forget it with `forgetMemory()`, all reactive.
+- **Documents** — ingest longer content with `addDocument()`, poll status with `refreshDocument()`, remove it with `deleteDocument()`.
+- **Search** — run `search()` against whichever containerTag is selected, showing result score, matching chunks, and Supermemory's own reported `total`/`timing`.
+- **containerTag switcher** — a row of chips lets you flip between a few demo users live, so you can see the exact same actions land in completely separate memory spaces.
+- **History** — every memory and document ever written in the deployment, newest first, across every containerTag. Expand a row for full detail, or hit **Recreate live** to replay it as a brand-new memory/document.
+- **Activity console** — a side-docked live log of every call this app makes into the Supermemory client, including real API errors (e.g. Supermemory returns `409` if you try to delete a document that's still processing).
+
+Run it from the repo root:
+
+```bash
+npm install --legacy-peer-deps
+npx convex env set SUPERMEMORY_API_KEY sm_xxxxxxxxxxxx
+npm run dev
+```
+
+`npm run dev` starts the Convex backend and the Vite frontend together — there's no need to `cd example` or run either one separately.
+
+## Limitations
+
+- `search()` always calls Supermemory live — results are not cached or mirrored into Convex tables, since they're a ranked view over the underlying memories/documents rather than durable records themselves.
+- Document processing is asynchronous; this component does not poll for you. Call `refreshDocument()` on a schedule (e.g. a Convex cron or scheduled function) if you need status without a user-triggered refresh.
+- `forgetMemory()` reflects whatever `forgotten` value Supermemory returns — if Supermemory forgets asynchronously, the local record may briefly still show `forgotten: false`.
+- `deleteDocument()` throws if Supermemory reports the document is still processing (`409`) — retry after the document reaches a terminal status (`done`/`failed`).
+
+## Troubleshooting
+
+**401/403 from Supermemory** — confirm `SUPERMEMORY_API_KEY` is set and starts with `sm_`.
+
+**Search returns nothing** — confirm you're searching the same `containerTag` you wrote memories/documents into; container tags are exact-match scopes, not fuzzy. If the document was ingested moments ago, give it a few seconds to finish indexing even after `refreshDocument()` reports `done`.
+
+**Document stuck in `queued`/`extracting`** — large documents can take longer to process; call `refreshDocument()` again after a short delay.
+
+**Deleting a document fails with a "still processing" error** — Supermemory returns `409` for a document that hasn't reached a terminal status yet; wait for `refreshDocument()` to report `done` or `failed`, then delete.
+
+## Contributing
+
+See [CONTRIBUTING.md](./CONTRIBUTING.md).
+
+## Changelog
+
+See [CHANGELOG.md](./CHANGELOG.md).

package/dist/client/_generated/_ignore.d.ts

@@ -0,0 +1 @@
+//# sourceMappingURL=_ignore.d.ts.map

package/dist/client/_generated/_ignore.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"_ignore.d.ts","sourceRoot":"","sources":["../../../src/client/_generated/_ignore.ts"],"names":[],"mappings":""}

package/dist/client/_generated/_ignore.js

@@ -0,0 +1,3 @@
+"use strict";
+// This is only here so convex-test can detect a _generated folder
+//# sourceMappingURL=_ignore.js.map

package/dist/client/_generated/_ignore.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"_ignore.js","sourceRoot":"","sources":["../../../src/client/_generated/_ignore.ts"],"names":[],"mappings":";AAAA,kEAAkE"}