oortmem 0.1.0 → 0.1.1

package/dist/cloud-remote.d.ts

@@ -0,0 +1,9 @@
+import type { RemoteMemory } from '@oortmem/claude-code';
+import { type CloudClient } from './cloud.js';
+export declare function cloudTurnRef(ref: string): string;
+/**
+ * The hooks' view of Oort Cloud. Recall and save go to the API; every failure rejects (the hooks
+ * then inject nothing, and the drain keeps account-level refusals queued). With no client (no Oort
+ * key, a bad URL), every call rejects the same way.
+ */
+export declare function cloudRemote(client: CloudClient | undefined, problem?: string): RemoteMemory;

package/dist/cloud-remote.js

@@ -0,0 +1,72 @@
+import { createHash } from 'node:crypto';
+import { OortCloudError } from './cloud.js';
+/** The API's turnRef cap; a longer ref is replaced by its hash (still stable across retries). */
+const TURN_REF_MAX = 128;
+export function cloudTurnRef(ref) {
+    return ref.length <= TURN_REF_MAX && /^[\x20-\x7e]+$/.test(ref)
+        ? ref
+        : createHash('sha256').update(ref).digest('hex');
+}
+/** Pinned and hot memories SessionStart injects: at most this many of each from the API. */
+const SESSION_LIMIT = 100;
+/**
+ * The hooks' view of Oort Cloud. Recall and save go to the API; every failure rejects (the hooks
+ * then inject nothing, and the drain keeps account-level refusals queued). With no client (no Oort
+ * key, a bad URL), every call rejects the same way.
+ */
+export function cloudRemote(client, problem) {
+    const missing = () => {
+        throw Object.assign(new Error(problem ?? 'Oort Cloud is not set up on this machine.'), {
+            holdQueue: true,
+        });
+    };
+    if (client === undefined) {
+        return {
+            recall: async () => missing(),
+            sessionMemories: async () => missing(),
+            observe: async () => missing(),
+        };
+    }
+    return {
+        recall: ({ text, projectId }) => client.recall({ text, ...(projectId !== undefined && { project: projectId }), k: 10 }),
+        sessionMemories: async ({ projectId }) => {
+            const project = projectId !== undefined && { project: projectId };
+            // Pinned first (any tier), then the hot tier; a memory in both appears once.
+            const [pinned, hot] = await Promise.all([
+                client.list({ ...project, pinned: true, limit: SESSION_LIMIT }),
+                client.list({ ...project, tier: 'hot', limit: SESSION_LIMIT }),
+            ]);
+            const seen = new Set();
+            const out = [];
+            for (const m of [...pinned.memories, ...hot.memories]) {
+                if (seen.has(m.id))
+                    continue;
+                seen.add(m.id);
+                out.push(m);
+            }
+            return out;
+        },
+        observe: async (obs, projectId, turnRef) => {
+            try {
+                // A repeat of the same turnRef answers `duplicate: true`: already saved, so success.
+                await client.observe({
+                    ...(projectId !== undefined && { project: projectId }),
+                    ...(turnRef !== undefined && { turnRef: cloudTurnRef(turnRef) }),
+                    observation: {
+                        user: obs.userText,
+                        assistant: obs.assistantText,
+                        at: obs.at,
+                        ...(obs.sessionId !== undefined && { session: obs.sessionId }),
+                        ...(obs.toolSummaries.length > 0 && { tools: obs.toolSummaries }),
+                    },
+                });
+            }
+            catch (e) {
+                if (e instanceof OortCloudError)
+                    throw e; // carries holdQueue
+                throw Object.assign(new Error('Oort Cloud save failed.'), { holdQueue: true });
+            }
+        },
+    };
+}
+//# sourceMappingURL=cloud-remote.js.map

package/dist/cloud.d.ts

@@ -0,0 +1,139 @@
+import type { Memory, RecallResult, Tier } from '@oortmem/core';
+import type { Env } from './io.js';
+import { Refusal } from './util.js';
+/**
+ * Oort Cloud, as the CLI sees it: where the API is, which store this machine uses, and what the
+ * API's refusals mean. The API itself lives in the private oortcloud repo (apps/cloud); the routes
+ * and shapes the CLI relies on are pinned in `test/cloud-contract.json`.
+ */
+export declare const DEFAULT_CLOUD_URL = "https://api.oortcloud.dev";
+/**
+ * The API root: `OORT_CLOUD_URL` when set and non-empty (local dev against `wrangler dev`), else
+ * `DEFAULT_CLOUD_URL`. Only https, or http to a loopback host: the Oort key travels in every
+ * request.
+ */
+export declare function cloudUrl(env: Env): {
+    url: string;
+} | {
+    error: string;
+};
+export type StoreMode = 'local' | 'cloud';
+export interface ImportProgress {
+    /** A fingerprint of the export being uploaded (count and first and last id). */
+    fingerprint: string;
+    /** Memory lines already accepted by the cloud. */
+    done: number;
+    total: number;
+    updatedAt: string;
+}
+export interface CloudSettings {
+    store: StoreMode;
+    import?: ImportProgress;
+}
+export declare const cloudSettingsPath: (home: string) => string;
+export declare function readCloudSettings(home: string): CloudSettings;
+export declare function writeCloudSettings(home: string, s: CloudSettings): void;
+export type CloudErrorKind = 'unauthorized' | 'payment-required' | 'not-enabled' | 'rate-limit' | 'too-large' | 'not-found' | 'ambiguous-prefix' | 'bad-request' | 'busy' | 'network';
+/**
+ * A refusal from Oort Cloud the user can act on: one line saying what happened and the fix. It
+ * never carries the key or the request. The API's own message is used where it explains a limit
+ * (the monthly cap says which and when it resets).
+ */
+export declare class OortCloudError extends Refusal {
+    readonly kind: CloudErrorKind;
+    readonly status: number;
+    /** The drain keeps the line queued instead of counting an attempt. */
+    readonly holdQueue: boolean;
+    constructor(kind: CloudErrorKind, status: number, apiMessage?: string);
+}
+/** The kind an API status (and `{ error: { code } }`) stands for. */
+export declare function cloudErrorKind(status: number, code?: string): CloudErrorKind;
+export type CloudMemory = Omit<Memory, 'embedding'>;
+export interface CloudStats {
+    tiers: Record<Tier, number>;
+    memories: number;
+    databaseBytes: number;
+    lastConsolidatedAt: string | null;
+}
+export interface CloudObservation {
+    user: string;
+    assistant: string;
+    at?: string;
+    session?: string;
+    tools?: string[];
+}
+export interface CloudObserveResult {
+    outcome: string;
+    memories: {
+        id?: string;
+        action: string;
+    }[];
+    counts: Record<string, number>;
+    /** The turnRef was seen before: the turn is already saved and nothing was done. */
+    duplicate?: true;
+}
+export interface CloudImportResult {
+    imported: number;
+    skipped: number;
+    reembedded: number;
+    next?: number;
+}
+export interface CloudClient {
+    readonly url: string;
+    whoami(): Promise<{
+        account: string;
+        plan: string;
+        via: string;
+    }>;
+    recall(q: {
+        text: string;
+        project?: string;
+        k?: number;
+        asOf?: string;
+    }): Promise<RecallResult>;
+    /** `turnRef` makes a retry safe: the API saves each turn once and answers `duplicate`. */
+    observe(b: {
+        project?: string;
+        observation: CloudObservation;
+        turnRef?: string;
+    }): Promise<CloudObserveResult>;
+    list(q?: {
+        project?: string;
+        tier?: Tier;
+        type?: string;
+        q?: string;
+        pinned?: boolean;
+        cursor?: string;
+        limit?: number;
+    }): Promise<{
+        memories: CloudMemory[];
+        next?: string;
+    }>;
+    /** By id, or by a unique prefix of at least 8 characters (409 `ambiguous` when several match). */
+    get(ref: string): Promise<CloudMemory>;
+    forget(id: string): Promise<void>;
+    pin(id: string, pinned: boolean): Promise<void>;
+    stats(): Promise<CloudStats>;
+    /** The v1 export, as JSON Lines text. */
+    exportText(): Promise<string>;
+    /**
+     * Posts export lines (the first is the manifest). One call imports at most 1,000 lines; when
+     * `next` is set, post the same lines again with `from = next` to continue.
+     */
+    importLines(lines: string[], from?: number): Promise<CloudImportResult>;
+}
+export interface CloudClientOptions {
+    url: string;
+    key: string;
+    fetch?: typeof fetch;
+    /** Per-request timeout; the hooks pass their own budget. */
+    timeoutMs?: number;
+}
+export declare function createCloudClient(opts: CloudClientOptions): CloudClient;
+/** The shortest id prefix the API looks up (it answers 404 below this). */
+export declare const MIN_ID_PREFIX = 8;
+/**
+ * A memory by id or unique id prefix (what `oort inspect` prints), looked up by the API itself:
+ * a prefix that matches several memories is refused with a clear message.
+ */
+export declare function findCloudMemory(client: CloudClient, ref: string): Promise<CloudMemory>;

package/dist/cloud.js

@@ -0,0 +1,223 @@
+import * as fs from 'node:fs';
+import * as path from 'node:path';
+import { ACCOUNT_URL } from './relay.js';
+import { Refusal, writeOwnerOnly } from './util.js';
+/**
+ * Oort Cloud, as the CLI sees it: where the API is, which store this machine uses, and what the
+ * API's refusals mean. The API itself lives in the private oortcloud repo (apps/cloud); the routes
+ * and shapes the CLI relies on are pinned in `test/cloud-contract.json`.
+ */
+export const DEFAULT_CLOUD_URL = 'https://api.oortcloud.dev';
+const LOOPBACK = new Set(['localhost', '127.0.0.1', '[::1]']);
+/**
+ * The API root: `OORT_CLOUD_URL` when set and non-empty (local dev against `wrangler dev`), else
+ * `DEFAULT_CLOUD_URL`. Only https, or http to a loopback host: the Oort key travels in every
+ * request.
+ */
+export function cloudUrl(env) {
+    const raw = env['OORT_CLOUD_URL'];
+    if (raw === undefined || raw === '')
+        return { url: DEFAULT_CLOUD_URL };
+    let u;
+    try {
+        u = new URL(raw);
+    }
+    catch {
+        return { error: 'OORT_CLOUD_URL is not a URL; unset it to use Oort Cloud.' };
+    }
+    const ok = u.protocol === 'https:' || (u.protocol === 'http:' && LOOPBACK.has(u.hostname));
+    if (!ok || u.username !== '' || u.password !== '' || u.search !== '' || u.hash !== '') {
+        return {
+            error: 'OORT_CLOUD_URL must be an https URL (or http to localhost) with no credentials or query; unset it to use Oort Cloud.',
+        };
+    }
+    return { url: `${u.origin}${u.pathname.replace(/\/+$/, '')}` };
+}
+export const cloudSettingsPath = (home) => path.join(home, 'cloud.json');
+export function readCloudSettings(home) {
+    let raw;
+    try {
+        raw = JSON.parse(fs.readFileSync(cloudSettingsPath(home), 'utf8'));
+    }
+    catch {
+        return { store: 'local' };
+    }
+    const r = raw;
+    const store = r?.store === 'cloud' ? 'cloud' : 'local';
+    const imp = r?.import;
+    const progress = imp !== undefined &&
+        typeof imp.fingerprint === 'string' &&
+        typeof imp.done === 'number' &&
+        typeof imp.total === 'number'
+        ? {
+            fingerprint: imp.fingerprint,
+            done: imp.done,
+            total: imp.total,
+            updatedAt: typeof imp.updatedAt === 'string' ? imp.updatedAt : '',
+        }
+        : undefined;
+    return { store, ...(progress !== undefined && { import: progress }) };
+}
+export function writeCloudSettings(home, s) {
+    fs.mkdirSync(home, { recursive: true, mode: 0o700 });
+    writeOwnerOnly(cloudSettingsPath(home), `${JSON.stringify(s, null, 2)}\n`, true);
+}
+/** Kinds the account has to fix, or that pass with time: a hook's queue waits instead. */
+const HOLD = new Set([
+    'unauthorized',
+    'payment-required',
+    'not-enabled',
+    'rate-limit',
+    'busy',
+    'network',
+]);
+/**
+ * A refusal from Oort Cloud the user can act on: one line saying what happened and the fix. It
+ * never carries the key or the request. The API's own message is used where it explains a limit
+ * (the monthly cap says which and when it resets).
+ */
+export class OortCloudError extends Refusal {
+    kind;
+    status;
+    /** The drain keeps the line queued instead of counting an attempt. */
+    holdQueue;
+    constructor(kind, status, apiMessage) {
+        super(messageFor(kind, status, apiMessage));
+        this.name = 'OortCloudError';
+        this.kind = kind;
+        this.status = status;
+        this.holdQueue = HOLD.has(kind);
+    }
+}
+function messageFor(kind, status, api) {
+    switch (kind) {
+        case 'unauthorized':
+            return `Oort Cloud rejected the Oort key (HTTP ${status}): it is unknown or revoked. Run \`oort login\` again.`;
+        case 'payment-required':
+            return `Oort Pro is not active on this account (HTTP 402). Subscribe or update billing at ${ACCOUNT_URL}, or run \`oort cloud use --local\`. \`oort cloud export\` still works.`;
+        case 'not-enabled':
+            return 'Oort Cloud is not enabled for this account yet (HTTP 403). Your memories stay on this machine; run `oort cloud use --local`.';
+        case 'rate-limit':
+            return `Oort Cloud limit reached (HTTP 429)${api !== undefined ? `: ${api}` : '.'} Usage is at ${ACCOUNT_URL}.`;
+        case 'too-large':
+            return `Oort Cloud refused a request that is too large (HTTP 413)${api !== undefined ? `: ${api}` : '.'}`;
+        case 'not-found':
+            return 'No such memory in Oort Cloud.';
+        case 'ambiguous-prefix':
+            return 'That id prefix matches more than one memory in Oort Cloud; give more of the id.';
+        case 'bad-request':
+            return `Oort Cloud refused the request (HTTP ${status})${api !== undefined ? `: ${api}` : '.'}`;
+        case 'busy':
+            return `Oort Cloud is busy or down, try again shortly (HTTP ${status}).`;
+        case 'network':
+            return 'Oort Cloud is unreachable: check your network, then try again.';
+    }
+}
+/** The kind an API status (and `{ error: { code } }`) stands for. */
+export function cloudErrorKind(status, code) {
+    if (status === 401)
+        return 'unauthorized';
+    if (status === 402)
+        return 'payment-required';
+    if (status === 403)
+        return code === 'cloud_not_enabled' ? 'not-enabled' : 'unauthorized';
+    if (status === 404)
+        return 'not-found';
+    if (status === 409 && code === 'ambiguous')
+        return 'ambiguous-prefix';
+    if (status === 413)
+        return 'too-large';
+    if (status === 429)
+        return 'rate-limit';
+    if (status >= 500)
+        return 'busy';
+    return 'bad-request';
+}
+const DEFAULT_TIMEOUT_MS = 30_000;
+export function createCloudClient(opts) {
+    const doFetch = opts.fetch ?? globalThis.fetch;
+    const timeout = opts.timeoutMs ?? DEFAULT_TIMEOUT_MS;
+    async function call(method, route, body) {
+        const abort = new AbortController();
+        const timer = setTimeout(() => abort.abort(), timeout);
+        const headers = { authorization: `Bearer ${opts.key}` };
+        let payload;
+        if (body?.json !== undefined) {
+            headers['content-type'] = 'application/json';
+            payload = JSON.stringify(body.json);
+        }
+        else if (body?.text !== undefined) {
+            headers['content-type'] = 'application/x-ndjson';
+            payload = body.text;
+        }
+        let res;
+        try {
+            res = await doFetch(`${opts.url}${route}`, {
+                method,
+                headers,
+                ...(payload !== undefined && { body: payload }),
+                signal: abort.signal,
+                redirect: 'error',
+            });
+        }
+        catch {
+            throw new OortCloudError('network', 0);
+        }
+        finally {
+            clearTimeout(timer);
+        }
+        if (!res.ok) {
+            const err = (await res.json().catch(() => ({})));
+            const code = typeof err.error?.code === 'string' ? err.error.code : undefined;
+            const message = typeof err.error?.message === 'string' ? err.error.message : undefined;
+            throw new OortCloudError(cloudErrorKind(res.status, code), res.status, message);
+        }
+        return res;
+    }
+    const json = async (method, route, body) => (await (await call(method, route, body === undefined ? undefined : { json: body })).json());
+    const idPath = (id) => `/v1/memories/${encodeURIComponent(id)}`;
+    return {
+        url: opts.url,
+        whoami: () => json('GET', '/v1/whoami'),
+        recall: (q) => json('POST', '/v1/recall', q),
+        observe: (b) => json('POST', '/v1/observe', b),
+        list: (q = {}) => {
+            const p = new URLSearchParams();
+            for (const [k, v] of Object.entries(q))
+                if (v !== undefined)
+                    p.set(k, String(v));
+            const qs = p.toString();
+            return json('GET', `/v1/memories${qs === '' ? '' : `?${qs}`}`);
+        },
+        get: (id) => json('GET', idPath(id)),
+        forget: async (id) => {
+            await call('DELETE', idPath(id));
+        },
+        pin: async (id, pinned) => {
+            await call('POST', `${idPath(id)}/${pinned ? 'pin' : 'unpin'}`);
+        },
+        stats: () => json('GET', '/v1/stats'),
+        exportText: async () => (await call('GET', '/v1/export')).text(),
+        importLines: async (lines, from = 0) => (await (await call('POST', `/v1/import?from=${from}`, {
+            text: lines.map((l) => `${l}\n`).join(''),
+        })).json()),
+    };
+}
+/** The shortest id prefix the API looks up (it answers 404 below this). */
+export const MIN_ID_PREFIX = 8;
+/**
+ * A memory by id or unique id prefix (what `oort inspect` prints), looked up by the API itself:
+ * a prefix that matches several memories is refused with a clear message.
+ */
+export async function findCloudMemory(client, ref) {
+    try {
+        return await client.get(ref);
+    }
+    catch (e) {
+        if (e instanceof OortCloudError && e.kind === 'not-found' && ref.length < MIN_ID_PREFIX) {
+            throw new Refusal(`Give at least ${MIN_ID_PREFIX} characters of the memory id.`);
+        }
+        throw e;
+    }
+}
+//# sourceMappingURL=cloud.js.map

package/dist/commands/cloud.d.ts

@@ -0,0 +1,34 @@
+import { type CloudClient } from '../cloud.js';
+import { type Ctx } from '../util.js';
+/** One import request: at most this many memory lines and bytes (the API takes 1,000 and 10 MB). */
+export declare const IMPORT_CHUNK_LINES = 500;
+export declare const IMPORT_CHUNK_BYTES: number;
+/**
+ * Uploads one chunk. The API imports at most 1,000 lines a call and answers `next` (an index into
+ * the posted lines) when it stopped early; the same lines are posted again with `from = next`
+ * until it is done. `progress` gets how many of the chunk's lines are in after each call.
+ */
+export declare function uploadChunk(client: CloudClient, header: string, lines: string[], progress: (inChunk: number) => void): Promise<{
+    imported: number;
+    skipped: number;
+    reembedded: number;
+    calls: number;
+}>;
+/** `oort cloud use [--local]`: switch this machine's store. */
+export declare function cloudUseCommand(opts: {
+    local?: boolean;
+}, ctx: Ctx): Promise<number>;
+/** `oort cloud status [--json]` */
+export declare function cloudStatusCommand(opts: {
+    json?: boolean;
+}, ctx: Ctx): Promise<number>;
+/** `oort cloud import [--dry-run] [--yes]`: uploads the local store, resumable and idempotent. */
+export declare function cloudImportCommand(opts: {
+    dryRun?: boolean;
+    yes?: boolean;
+}, ctx: Ctx): Promise<number>;
+/** `oort cloud export [--out <file>] [--force]`: the whole cloud account in the v1 format. */
+export declare function cloudExportCommand(opts: {
+    out?: string;
+    force?: boolean;
+}, ctx: Ctx): Promise<number>;