@oortmem/store-sqlite 0.0.0-stage → 0.1.0

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 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

@@ -1,3 +1,17 @@
-# Temporary Holding Version
+# @oortmem/store-sqlite
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+The local Oort store: SQLite with FTS5 for keywords, sqlite-vec for vectors, and zstd blobs for the cold tier.
+
+```sh
+npm install @oortmem/store-sqlite
+```
+
+```ts
+import { openSqliteStore } from '@oortmem/store-sqlite';
+
+const store = await openSqliteStore({ path: './oort.db', coldDir: './cold', dimension: 512 });
+```
+
+Directories it creates are owner-only.
+
+Part of [Oort](https://github.com/oortmem/oort), open-source memory for AI agents. See the [main README](https://github.com/oortmem/oort#readme) for how the pieces fit. Apache-2.0.

package/dist/blobs.d.ts

@@ -0,0 +1,60 @@
+/**
+ * The file layer under the SQLite store: owner-only directories and files,
+ * atomic unique-per-write cold blobs, and the crash-leftover sweep. No SQL here.
+ */
+export type Log = (message: string) => void;
+export declare function unlinkQuietly(file: string): void;
+/**
+ * Returns `original`, the error the caller must see, with any cleanup
+ * failures attached as its `cause` (an `AggregateError`; a cause it already
+ * had becomes that error's cause). A non-Error is returned unchanged.
+ */
+export declare function withCleanupFailures(original: unknown, failures: readonly unknown[]): unknown;
+export declare function chmodIfExists(file: string, mode: number): void;
+/**
+ * The database's directory. One the store creates is owner-only. An existing
+ * one (often a project root) is the caller's: it is never chmodded, only
+ * warned about when group or others can read it.
+ */
+export declare function prepareDbDir(dir: string, log: Log): void;
+/**
+ * Runs `fn` with umask 077 so files SQLite creates (`-wal`, `-shm`) are
+ * owner-only. The umask is process-global: while `fn` runs (synchronously),
+ * files created by other threads of this process also get 077. Worker threads
+ * cannot set it at all; there the explicit chmods after open are the only guard.
+ */
+export declare function withPrivateUmask<T>(fn: () => T): T;
+export interface BlobDir {
+    /**
+     * Writes a new uniquely named blob per item: temp files written with bounded
+     * parallelism, then all renamed, then one directory fsync. The files
+     * themselves are not fsynced (see the durability note above).
+     * Returns the file names in input order. On any failure every file this call
+     * created is removed and the error is rethrown.
+     */
+    writeMany(items: readonly {
+        id: string;
+        data: Uint8Array;
+    }[]): Promise<string[]>;
+    /** The blob's bytes, or null when it is missing or `name` is not a blob name. */
+    read(name: string): Buffer | null;
+    /** Removes a blob; missing files and non-blob names are ignored. */
+    remove(name: string): void;
+    /**
+     * `remove` for every name, best effort: one failing unlink does not stop the
+     * rest. Returns the failures (empty when all went).
+     */
+    removeAll(names: readonly string[]): unknown[];
+    /**
+     * Removes crash leftovers: blob temp files older than an hour, and blobs not
+     * in `referenced` older than a minute. Only when the directory carries the
+     * marker, and only files matching the blob-name pattern. Logs counts only.
+     */
+    sweep(referenced: ReadonlySet<string>): void;
+}
+/**
+ * Opens the cold directory, creating it owner-only (or tightening it). The
+ * marker is written when the directory is new or empty; a populated directory
+ * without one is not swept, so a misconfigured shared directory loses nothing.
+ */
+export declare function openBlobDir(dir: string, log: Log): BlobDir;

package/dist/blobs.js

@@ -0,0 +1,265 @@
+import { createHash, randomBytes } from 'node:crypto';
+import * as fs from 'node:fs';
+import * as fsp from 'node:fs/promises';
+import * as path from 'node:path';
+import { ensurePrivateDir } from '@oortmem/core';
+/** A `.zst.tmp` older than this is a crashed write. */
+const STALE_TMP_MS = 60 * 60 * 1000;
+/**
+ * An unreferenced blob younger than this may belong to another process's
+ * `coldPut` that has renamed it but not yet committed (the commit can wait up
+ * to the 5 s busy timeout), so the sweep leaves it for a later open.
+ */
+const ORPHAN_GRACE_MS = 60 * 1000;
+/** Marks a directory as an Oort cold directory; the sweep never runs without it. */
+const MARKER = '.oort-cold';
+/**
+ * `<safeId>.<pid>-<rand>.zst`, optionally `.tmp`. Unique per write, so one
+ * `coldPut` never overwrites, and a sweep or unlink never hits, another
+ * write's file. The sweep touches nothing that does not match.
+ */
+const BLOB_NAME = /^(?:[a-z0-9_-]{1,128}|~[0-9a-f]{64})\.\d+-[0-9a-f]{8}\.zst(\.tmp)?$/;
+/** Ids that are safe, case-insensitive-unique file names are used as is; anything else is hashed. */
+function safeId(id) {
+    return /^[a-z0-9_-]{1,128}$/.test(id) ? id : `~${createHash('sha256').update(id).digest('hex')}`;
+}
+export function unlinkQuietly(file) {
+    try {
+        fs.unlinkSync(file);
+    }
+    catch (e) {
+        if (e.code !== 'ENOENT')
+            throw e;
+    }
+}
+/** Runs every unlink, best effort; returns the failures (missing files are not failures). */
+function unlinkEach(files) {
+    const failures = [];
+    for (const file of files) {
+        try {
+            unlinkQuietly(file);
+        }
+        catch (e) {
+            failures.push(e);
+        }
+    }
+    return failures;
+}
+/**
+ * Returns `original`, the error the caller must see, with any cleanup
+ * failures attached as its `cause` (an `AggregateError`; a cause it already
+ * had becomes that error's cause). A non-Error is returned unchanged.
+ */
+export function withCleanupFailures(original, failures) {
+    if (failures.length === 0 || !(original instanceof Error))
+        return original;
+    const previous = original.cause;
+    original.cause = new AggregateError(failures, `cold blob cleanup: ${failures.length} unlink(s) failed`, previous === undefined ? undefined : { cause: previous });
+    return original;
+}
+export function chmodIfExists(file, mode) {
+    try {
+        fs.chmodSync(file, mode);
+    }
+    catch (e) {
+        if (e.code !== 'ENOENT')
+            throw e;
+    }
+}
+/**
+ * The database's directory. One the store creates is owner-only. An existing
+ * one (often a project root) is the caller's: it is never chmodded, only
+ * warned about when group or others can read it.
+ */
+export function prepareDbDir(dir, log) {
+    if (!fs.existsSync(dir)) {
+        fs.mkdirSync(dir, { recursive: true, mode: 0o700 });
+        return;
+    }
+    if (process.platform !== 'win32' && (fs.statSync(dir).mode & 0o077) !== 0) {
+        log(`oort: ${dir} is readable by group/others; memory files inside are 0600`);
+    }
+}
+/**
+ * Runs `fn` with umask 077 so files SQLite creates (`-wal`, `-shm`) are
+ * owner-only. The umask is process-global: while `fn` runs (synchronously),
+ * files created by other threads of this process also get 077. Worker threads
+ * cannot set it at all; there the explicit chmods after open are the only guard.
+ */
+export function withPrivateUmask(fn) {
+    let previous;
+    try {
+        previous = process.umask(0o077);
+    }
+    catch {
+        previous = undefined;
+    }
+    try {
+        return fn();
+    }
+    finally {
+        if (previous !== undefined)
+            process.umask(previous);
+    }
+}
+/** Opens a new owner-only file exclusively; a leftover file at `file` is removed and the open retried once. */
+async function openExclusive(file) {
+    try {
+        return await fsp.open(file, 'wx', 0o600);
+    }
+    catch (e) {
+        if (e.code !== 'EEXIST')
+            throw e;
+        unlinkQuietly(file);
+        return await fsp.open(file, 'wx', 0o600);
+    }
+}
+/**
+ * Durability note. Blob files are NOT fsynced individually; the rename and one
+ * directory fsync per batch are kept. Per-file fsync cost about 12 ms each and
+ * made the first consolidate of 10k memories take 60 s (25 s even with 8
+ * fsyncs in parallel). A cold blob holds the embedding and a snapshot only:
+ * the database row keeps text, stub and entities. After a power loss a blob
+ * may be torn or empty; the v2 frame's CRC32 detects that, `coldGet` returns
+ * null (logged), and recall falls back to the live row. Worst case the
+ * embedding is lost: nothing re-derives it yet, so the memory stays cold
+ * without one and is found lexically only (stub, entities).
+ * TODO(Phase 2): re-embed on hydration when an embedder is present.
+ * A process crash loses nothing
+ * (the page cache survives it). The database itself keeps its WAL durability.
+ */
+/** Blobs written at once: bounds open file handles. */
+const WRITE_CONCURRENCY = 8;
+/** Runs `fn` over `items` with at most `limit` in flight; every started task settles before this does. */
+async function mapBounded(items, limit, fn) {
+    const out = Array.from({ length: items.length });
+    let next = 0;
+    const worker = async () => {
+        while (next < items.length) {
+            const i = next++;
+            try {
+                out[i] = { status: 'fulfilled', value: await fn(items[i], i) };
+            }
+            catch (reason) {
+                out[i] = { status: 'rejected', reason };
+            }
+        }
+    };
+    await Promise.all(Array.from({ length: Math.min(limit, items.length) }, worker));
+    return out;
+}
+/** Best-effort fsync of a directory so a rename survives a crash (not supported everywhere). */
+function fsyncDir(dir) {
+    try {
+        const fd = fs.openSync(dir, 'r');
+        try {
+            fs.fsyncSync(fd);
+        }
+        finally {
+            fs.closeSync(fd);
+        }
+    }
+    catch {
+        // Windows cannot open directories; the rename is still atomic.
+    }
+}
+/**
+ * Opens the cold directory, creating it owner-only (or tightening it). The
+ * marker is written when the directory is new or empty; a populated directory
+ * without one is not swept, so a misconfigured shared directory loses nothing.
+ */
+export function openBlobDir(dir, log) {
+    if (ensurePrivateDir(dir))
+        log('oort store: tightened permissions to 0700 on the cold directory');
+    const marker = path.join(dir, MARKER);
+    if (!fs.existsSync(marker)) {
+        if (fs.readdirSync(dir).length === 0)
+            fs.closeSync(fs.openSync(marker, 'a', 0o600));
+        else
+            log(`oort: ${dir} has no ${MARKER} marker; orphan cold blob sweep disabled`);
+    }
+    return {
+        async writeMany(items) {
+            const names = items.map(({ id }) => `${safeId(id)}.${process.pid}-${randomBytes(4).toString('hex')}.zst`);
+            const tmpOf = (name) => path.join(dir, `${name}.tmp`);
+            const renamed = [];
+            // Best effort over every file this call created; never masks the original error.
+            const cleanup = () => unlinkEach(names.flatMap((name) => renamed.includes(name) ? [tmpOf(name), path.join(dir, name)] : [tmpOf(name)]));
+            try {
+                const written = await mapBounded(items, WRITE_CONCURRENCY, async ({ data }, i) => {
+                    const fh = await openExclusive(tmpOf(names[i]));
+                    try {
+                        await fh.writeFile(data);
+                    }
+                    finally {
+                        await fh.close();
+                    }
+                });
+                for (const r of written)
+                    if (r.status === 'rejected')
+                        throw r.reason;
+                for (const name of names) {
+                    await fsp.rename(tmpOf(name), path.join(dir, name));
+                    renamed.push(name);
+                }
+                fsyncDir(dir);
+            }
+            catch (e) {
+                throw withCleanupFailures(e, cleanup());
+            }
+            return names;
+        },
+        read(name) {
+            if (!BLOB_NAME.test(name) || name.endsWith('.tmp'))
+                return null;
+            try {
+                return fs.readFileSync(path.join(dir, name));
+            }
+            catch (e) {
+                if (e.code === 'ENOENT')
+                    return null;
+                throw e;
+            }
+        },
+        remove(name) {
+            if (BLOB_NAME.test(name))
+                unlinkQuietly(path.join(dir, name));
+        },
+        removeAll(names) {
+            return unlinkEach(names.filter((n) => BLOB_NAME.test(n)).map((n) => path.join(dir, n)));
+        },
+        sweep(referenced) {
+            if (!fs.existsSync(marker))
+                return;
+            const now = Date.now();
+            let tmps = 0;
+            let orphans = 0;
+            for (const name of fs.readdirSync(dir)) {
+                const m = BLOB_NAME.exec(name);
+                if (m === null)
+                    continue;
+                const isTmp = m[1] !== undefined;
+                if (!isTmp && referenced.has(name))
+                    continue;
+                let age;
+                try {
+                    age = now - fs.statSync(path.join(dir, name)).mtimeMs;
+                }
+                catch {
+                    continue;
+                }
+                if (age < (isTmp ? STALE_TMP_MS : ORPHAN_GRACE_MS))
+                    continue;
+                unlinkQuietly(path.join(dir, name));
+                if (isTmp)
+                    tmps++;
+                else
+                    orphans++;
+            }
+            if (tmps + orphans > 0) {
+                log(`oort store: removed ${orphans} orphan cold blob(s) and ${tmps} stale temp file(s)`);
+            }
+        },
+    };
+}
+//# sourceMappingURL=blobs.js.map

package/dist/cold.d.ts

@@ -0,0 +1,44 @@
+import type { Memory } from '@oortmem/core';
+/**
+ * Serialises a full memory (embedding included, so hydration never re-embeds)
+ * into a cold blob. Dictionary support is a Phase 2 extension; it gets its own
+ * frame version.
+ */
+export interface ColdCodec {
+    encode(m: Memory): Uint8Array;
+    /** Throws `ColdBlobCorruptError` for anything that is not an intact frame. */
+    decode(b: Uint8Array): Memory;
+}
+/** A cold blob that is truncated, bit-flipped, of an unknown version, or of the wrong dimension. */
+export declare class ColdBlobCorruptError extends Error {
+    constructor(message: string, options?: {
+        cause?: unknown;
+    });
+}
+export interface ColdCodecOptions {
+    /** When set, `decode` rejects a blob whose embedding has another length. */
+    dimension?: number;
+}
+/**
+ * Frame version 2 (written):
+ *
+ *     u8 version (0x02)
+ *     u32 big-endian length of the compressed JSON
+ *     zstd (level 19) of the UTF-8 JSON of the memory without its embedding
+ *     u32 big-endian embedding length (0 when absent)
+ *     raw int8 embedding bytes, uncompressed
+ *     u32 big-endian CRC32 of every byte before it
+ *
+ * Only the JSON is compressed. Quantised int8 embeddings are near-incompressible
+ * (a full-range 512-d vector grows under zstd), so compressing them costs CPU
+ * and frame overhead; and mixing them into the JSON's zstd block makes that
+ * block share one literal Huffman table between English and noise, which
+ * measurably hurts the text's compression too. The CRC and the explicit
+ * length make a truncated or bit-flipped blob fail loudly instead of decoding
+ * into a memory with a short embedding.
+ *
+ * Frame version 1 (read only): u8 0x01, u32 JSON length, zstd JSON, u8
+ * embedding flag, raw bytes. It has no checksum, so its embedding length is
+ * checked against `dimension` when known.
+ */
+export declare function createColdCodec(opts?: ColdCodecOptions): ColdCodec;