@aigne/afs-history 1.2.0-beta.3 → 1.2.0-beta.5

package/lib/esm/index.js

@@ -1,4 +1,5 @@
 import { v7 } from "@aigne/uuid";
+import { createRouter } from "radix3";
 import { joinURL } from "ufo";
 import { SharedAFSStorage, } from "./storage/index.js";
 export * from "./storage/index.js";
@@ -9,34 +10,205 @@ export class AFSHistory {
                 ? options.storage.withModule(this)
                 : new SharedAFSStorage(options?.storage).withModule(this);
     }
-    storage;
     name = "history";
+    storage;
+    afs;
+    router = createRouter({
+        routes: {
+            "/new": { type: "root", id: "new-history" },
+            "/by-session": { type: "root", id: "by-session" },
+            "/by-session/:sessionId": { type: "list", id: "by-session" },
+            "/by-session/:sessionId/@metadata/compact": { type: "compact-list", id: "by-session" },
+            "/by-session/:sessionId/@metadata/compact/new": { type: "compact-new", id: "by-session" },
+            "/by-session/:sessionId/@metadata/compact/:compactId": {
+                type: "compact-detail",
+                id: "by-session",
+            },
+            "/by-session/:sessionId/:entryId": { type: "detail", id: "by-session" },
+            "/by-user": { type: "root", id: "by-user" },
+            "/by-user/:userId": { type: "list", id: "by-user" },
+            "/by-user/:userId/@metadata/compact": { type: "compact-list", id: "by-user" },
+            "/by-user/:userId/@metadata/compact/new": { type: "compact-new", id: "by-user" },
+            "/by-user/:userId/@metadata/compact/:compactId": { type: "compact-detail", id: "by-user" },
+            "/by-user/:userId/:entryId": { type: "detail", id: "by-user" },
+            "/by-agent": { type: "root", id: "by-agent" },
+            "/by-agent/:agentId": { type: "list", id: "by-agent" },
+            "/by-agent/:agentId/@metadata/compact": { type: "compact-list", id: "by-agent" },
+            "/by-agent/:agentId/@metadata/compact/new": { type: "compact-new", id: "by-agent" },
+            "/by-agent/:agentId/@metadata/compact/:compactId": { type: "compact-detail", id: "by-agent" },
+            "/by-agent/:agentId/:entryId": { type: "detail", id: "by-agent" },
+        },
+    });
+    rootEntries = [
+        {
+            id: "new-history",
+            path: "/new",
+            description: "Write to this path to create a new history entry, generating a UUID-based path.",
+        },
+        {
+            id: "by-session",
+            path: "/by-session",
+            description: "Retrieve history entries by session ID.",
+        },
+        {
+            id: "by-user",
+            path: "/by-user",
+            description: "Retrieve history entries by user ID.",
+        },
+        {
+            id: "by-agent",
+            path: "/by-agent",
+            description: "Retrieve history entries by agent ID.",
+        },
+    ];
     onMount(afs) {
-        afs.on("agentSucceed", ({ input, output }) => {
-            this.storage
-                .create({
-                path: joinURL("/", v7()),
-                content: { input, output },
-            })
-                .then((entry) => {
-                afs.emit("historyCreated", { entry });
-            })
-                .catch((error) => {
-                console.error("Failed to store history entry", error);
-            });
-        });
+        this.afs = afs;
     }
     async list(path, options) {
-        if (path !== "/")
+        if (path === "/")
+            return { data: this.rootEntries };
+        // Parse virtual path and extract filter conditions
+        const match = this.router.lookup(path);
+        // If path doesn't match any virtual path pattern, return empty
+        if (!match) {
             return { data: [] };
-        return await this.storage.list(options);
+        }
+        const rootEntry = this.rootEntries.find((entry) => entry.path === `/${match.id}`);
+        if (!rootEntry)
+            return { data: [] };
+        if (match.type === "root") {
+            return { data: [rootEntry] };
+        }
+        const matchId = match.id;
+        if (match.type === "list" &&
+            (matchId === "by-session" || matchId === "by-user" || matchId === "by-agent")) {
+            // Merge virtual path filter with explicit filter options
+            const mergedFilter = {
+                ...options?.filter,
+                ...match.params,
+            };
+            const result = await this.storage.list({
+                ...options,
+                filter: mergedFilter,
+            });
+            // Add virtual path prefix to each entry's path
+            return {
+                ...result,
+                data: result.data.map((entry) => ({
+                    ...entry,
+                    path: this.normalizePath(entry, matchId),
+                })),
+            };
+        }
+        if (match.type === "compact-list" &&
+            (matchId === "by-session" || matchId === "by-user" || matchId === "by-agent")) {
+            const compactType = this.getCompactType(matchId);
+            const mergedFilter = {
+                ...options?.filter,
+                ...match.params,
+            };
+            const result = await this.storage.listCompact(compactType, {
+                ...options,
+                filter: mergedFilter,
+            });
+            return { data: result.data };
+        }
+        return { data: [] };
     }
-    async read(path) {
-        const data = await this.storage.read(path);
-        return { data };
+    async read(path, options) {
+        // Parse virtual path and extract filter conditions
+        const match = this.router.lookup(path);
+        if (!match)
+            return {};
+        const rootEntry = this.rootEntries.find((entry) => entry.path === `/${match.id}`);
+        if (!rootEntry)
+            return {};
+        if (match.type === "root") {
+            return { data: rootEntry };
+        }
+        if (match.type === "detail" &&
+            (match.id === "by-session" || match.id === "by-user" || match.id === "by-agent")) {
+            const entryId = match.params?.entryId;
+            if (!entryId)
+                throw new Error("Entry ID is required in the path to read detail.");
+            const data = await this.storage.read(entryId, {
+                filter: match.params,
+            });
+            return {
+                data: data && {
+                    ...data,
+                    path: this.normalizePath(data, match.id),
+                },
+            };
+        }
+        if (match.type === "compact-detail" &&
+            (match.id === "by-session" || match.id === "by-user" || match.id === "by-agent")) {
+            const compactId = match.params?.compactId;
+            if (!compactId)
+                throw new Error("Compact ID is required in the path to read compact detail.");
+            const compactType = this.getCompactType(match.id);
+            const mergedFilter = {
+                ...options?.filter,
+                ...match.params,
+            };
+            const data = await this.storage.readCompact(compactType, compactId, {
+                filter: mergedFilter,
+            });
+            return { data };
+        }
+        return {};
     }
     async write(path, content) {
-        const data = await this.storage.create({ ...content, path });
-        return { data };
+        const id = v7();
+        const match = this.router.lookup(path);
+        if (match?.type === "compact-new") {
+            const compactType = this.getCompactType(match.id);
+            const entry = await this.storage.createCompact(compactType, {
+                ...match.params,
+                ...content,
+                id,
+                path: joinURL("/", compactType, id),
+            });
+            return { data: entry };
+        }
+        if (match?.id !== "new-history") {
+            throw new Error("Can only write to /new or @metadata/compact/new paths.");
+        }
+        if (!content.sessionId)
+            throw new Error("sessionId is required to create a history entry.");
+        const entry = await this.storage.create({
+            ...content,
+            id,
+            path: joinURL("/", id),
+        });
+        this.afs?.emit("historyCreated", { entry });
+        return {
+            data: {
+                ...entry,
+                path: this.normalizePath(entry, "by-session"),
+            },
+        };
+    }
+    getCompactType(id) {
+        const mapping = {
+            "by-session": "session",
+            "by-user": "user",
+            "by-agent": "agent",
+        };
+        const type = mapping[id];
+        if (!type)
+            throw new Error(`Invalid compact type for id: ${id}`);
+        return type;
+    }
+    normalizePath(entry, type) {
+        const [prefix, scopeId] = {
+            "by-session": ["by-session", entry.sessionId],
+            "by-user": ["by-user", entry.userId],
+            "by-agent": ["by-agent", entry.agentId],
+        }[type] || [];
+        if (!prefix || !scopeId) {
+            throw new Error(`Cannot reset path for entry without ${type} info.`);
+        }
+        return joinURL("/", prefix, scopeId, entry.id);
     }
 }

package/lib/esm/storage/index.d.ts

@@ -1,7 +1,6 @@
 import type { AFSEntry, AFSModule } from "@aigne/afs";
 import { initDatabase } from "@aigne/sqlite";
-import { entriesTable } from "./models/entries.js";
-import type { AFSStorage, AFSStorageCreatePayload, AFSStorageListOptions } from "./type.js";
+import type { AFSStorage, AFSStorageCreatePayload, AFSStorageListOptions, AFSStorageReadOptions, CompactType } from "./type.js";
 export * from "./type.js";
 export interface SharedAFSStorageOptions {
     url?: string;
@@ -17,11 +16,18 @@ export declare class SharedAFSStorage {
 }
 export declare class AFSStorageWithModule implements AFSStorage {
     private db;
-    private table;
-    constructor(db: ReturnType<typeof initDatabase>, table: Promise<ReturnType<typeof entriesTable>>);
+    private module;
+    constructor(db: ReturnType<typeof initDatabase>, module: AFSModule);
+    private _tables?;
+    private get tables();
     list(options?: AFSStorageListOptions): Promise<{
         data: AFSEntry[];
     }>;
-    read(path: string): Promise<AFSEntry | undefined>;
+    read(id: string, options?: AFSStorageReadOptions): Promise<AFSEntry | undefined>;
     create(entry: AFSStorageCreatePayload): Promise<AFSEntry>;
+    createCompact(type: CompactType, entry: AFSStorageCreatePayload): Promise<AFSEntry>;
+    listCompact(type: CompactType, options?: AFSStorageListOptions): Promise<{
+        data: AFSEntry[];
+    }>;
+    readCompact(type: CompactType, id: string, options?: AFSStorageReadOptions): Promise<AFSEntry | undefined>;
 }

package/lib/esm/storage/index.js

@@ -1,5 +1,6 @@
-import { and, asc, desc, eq, initDatabase, sql } from "@aigne/sqlite";
+import { and, asc, desc, eq, gt, initDatabase, lt, sql } from "@aigne/sqlite";
 import { migrate } from "./migrate.js";
+import { compactTable } from "./models/compact.js";
 import { entriesTable } from "./models/entries.js";
 export * from "./type.js";
 const DEFAULT_AFS_STORAGE_LIST_LIMIT = 10;
@@ -14,55 +15,103 @@ export class SharedAFSStorage {
         return this._db;
     }
     withModule(module) {
-        return new AFSStorageWithModule(this.db, migrate(this.db, module).then(() => entriesTable(module)));
+        return new AFSStorageWithModule(this.db, module);
     }
 }
 export class AFSStorageWithModule {
     db;
-    table;
-    constructor(db, table) {
+    module;
+    constructor(db, module) {
         this.db = db;
-        this.table = table;
+        this.module = module;
+    }
+    _tables;
+    get tables() {
+        if (!this._tables) {
+            this._tables = this.db.then((db) => migrate(db, this.module).then(() => ({
+                db,
+                entries: entriesTable(this.module),
+                compact: compactTable(this.module),
+            })));
+        }
+        return this._tables;
     }
     async list(options = {}) {
         const { filter, limit = DEFAULT_AFS_STORAGE_LIST_LIMIT } = options;
-        const db = await this.db;
-        const table = await this.table;
+        const { db, entries } = await this.tables;
         const data = await db
             .select()
-            .from(table)
-            .where(and(filter?.userId ? eq(table.userId, filter.userId) : undefined, filter?.sessionId ? eq(table.sessionId, filter.sessionId) : undefined))
+            .from(entries)
+            .where(and(filter?.agentId ? eq(entries.agentId, filter.agentId) : undefined, filter?.userId ? eq(entries.userId, filter.userId) : undefined, filter?.sessionId ? eq(entries.sessionId, filter.sessionId) : undefined, filter?.before ? lt(entries.createdAt, new Date(filter.before)) : undefined, filter?.after ? gt(entries.createdAt, new Date(filter.after)) : undefined))
             .orderBy(...(options.orderBy ?? []).map((item) => (item[1] === "asc" ? asc : desc)(sql.identifier(item[0]))))
             .limit(limit)
             .execute();
         return { data };
     }
-    async read(path) {
-        const db = await this.db;
-        const table = await this.table;
+    async read(id, options) {
+        const { db, entries } = await this.tables;
         return db
             .select()
-            .from(table)
-            .where(eq(table.path, path))
+            .from(entries)
+            .where(and(eq(entries.id, id), options?.filter?.agentId ? eq(entries.agentId, options.filter.agentId) : undefined, options?.filter?.userId ? eq(entries.userId, options.filter.userId) : undefined, options?.filter?.sessionId ? eq(entries.sessionId, options.filter.sessionId) : undefined))
             .limit(1)
             .execute()
             .then((memory) => memory.at(0));
     }
     async create(entry) {
-        const db = await this.db;
-        const table = await this.table;
+        const { db, entries } = await this.tables;
         let result = await db
-            .update(table)
+            .update(entries)
             .set(entry)
-            .where(eq(table.path, entry.path))
+            .where(eq(entries.id, entry.id))
             .returning()
             .execute();
         if (!result.length) {
-            result = await db.insert(table).values(entry).returning().execute();
+            result = await db.insert(entries).values(entry).returning().execute();
         }
         const [res] = result;
         if (!res)
             throw new Error("Failed to create AFS entry, no result");
         return res;
     }
+    async createCompact(type, entry) {
+        const { db, compact } = await this.tables;
+        const result = await db
+            .insert(compact)
+            .values({
+            ...entry,
+            metadata: {
+                ...entry.metadata,
+                type,
+            },
+        })
+            .returning()
+            .execute();
+        const [res] = result;
+        if (!res)
+            throw new Error(`Failed to create ${type} compact entry, no result`);
+        return res;
+    }
+    async listCompact(type, options = {}) {
+        const { db, compact } = await this.tables;
+        const { filter, limit = DEFAULT_AFS_STORAGE_LIST_LIMIT } = options;
+        const data = await db
+            .select()
+            .from(compact)
+            .where(and(eq(sql `json_extract(${compact.metadata}, '$.type')`, type), filter?.agentId ? eq(compact.agentId, filter.agentId) : undefined, filter?.userId ? eq(compact.userId, filter.userId) : undefined, filter?.sessionId ? eq(compact.sessionId, filter.sessionId) : undefined, filter?.before ? lt(compact.createdAt, new Date(filter.before)) : undefined, filter?.after ? gt(compact.createdAt, new Date(filter.after)) : undefined))
+            .orderBy(...(options.orderBy ?? []).map((item) => (item[1] === "asc" ? asc : desc)(sql.identifier(item[0]))))
+            .limit(limit)
+            .execute();
+        return { data };
+    }
+    async readCompact(type, id, options) {
+        const { db, compact } = await this.tables;
+        return db
+            .select()
+            .from(compact)
+            .where(and(eq(sql `json_extract(${compact.metadata}, '$.type')`, type), eq(compact.id, id), options?.filter?.agentId ? eq(compact.agentId, options.filter.agentId) : undefined, options?.filter?.userId ? eq(compact.userId, options.filter.userId) : undefined, options?.filter?.sessionId ? eq(compact.sessionId, options.filter.sessionId) : undefined))
+            .limit(1)
+            .execute()
+            .then((rows) => rows.at(0));
+    }
 }

package/lib/esm/storage/migrate.d.ts

@@ -1,3 +1,3 @@
 import type { AFSModule } from "@aigne/afs";
 import { type initDatabase } from "@aigne/sqlite";
-export declare function migrate(db: ReturnType<typeof initDatabase>, module: AFSModule): Promise<void>;
+export declare function migrate(db: Awaited<ReturnType<typeof initDatabase>>, module: AFSModule): Promise<void>;

package/lib/esm/storage/migrate.js

@@ -1,8 +1,10 @@
 import { sql } from "@aigne/sqlite";
 import { v7 } from "@aigne/uuid";
 import { init } from "./migrations/001-init.js";
+import { addAgentId } from "./migrations/002-add-agent-id.js";
+import { addCompactTable } from "./migrations/003-add-compact-table.js";
 export async function migrate(db, module) {
-    const migrations = [init];
+    const migrations = [init, addAgentId, addCompactTable];
     const migrationsTable = "__drizzle_migrations";
     const migrationTableCreate = sql `
     CREATE TABLE IF NOT EXISTS ${sql.identifier(migrationsTable)} (
@@ -11,18 +13,18 @@ export async function migrate(db, module) {
       "hash" TEXT NOT NULL
     )
   `;
-    await (await db).run(migrationTableCreate).execute();
-    const dbMigrations = await (await db)
+    await db.run(migrationTableCreate).execute();
+    const dbMigrations = await db
         .values(sql `SELECT "id", "moduleId", "hash" FROM ${sql.identifier(migrationsTable)} WHERE "moduleId" = ${sql.param(module.name)} ORDER BY id DESC LIMIT 1`)
         .execute();
     const lastDbMigration = dbMigrations[0];
     const queriesToRun = [];
     for (const migration of migrations) {
-        if (!lastDbMigration || lastDbMigration[1] < migration.hash) {
+        if (!lastDbMigration || lastDbMigration[2] < migration.hash) {
             queriesToRun.push(...migration.sql(module), sql `INSERT INTO ${sql.identifier(migrationsTable)} ("id", "moduleId", "hash") VALUES(${sql.param(v7())}, ${sql.param(module.name)}, ${sql.param(migration.hash)})`);
         }
     }
     for (const query of queriesToRun) {
-        await (await db).run(query).execute();
+        await db.run(query).execute();
     }
 }

package/lib/esm/storage/migrations/002-add-agent-id.d.ts

@@ -0,0 +1,2 @@
+import type { AFSStorageMigrations } from "../type.js";
+export declare const addAgentId: AFSStorageMigrations;

package/lib/esm/storage/migrations/002-add-agent-id.js

@@ -0,0 +1,10 @@
+import { sql } from "@aigne/sqlite";
+import { entriesTableName } from "../models/entries.js";
+export const addAgentId = {
+    hash: "002-add-agent-id",
+    sql: (module) => [
+        sql `\
+ALTER TABLE ${sql.identifier(entriesTableName(module))} ADD COLUMN "agentId" TEXT;
+`,
+    ],
+};

package/lib/esm/storage/migrations/003-add-compact-table.d.ts

@@ -0,0 +1,2 @@
+import type { AFSStorageMigrations } from "../type.js";
+export declare const addCompactTable: AFSStorageMigrations;

package/lib/esm/storage/migrations/003-add-compact-table.js

@@ -0,0 +1,20 @@
+import { sql } from "@aigne/sqlite";
+import { compactTableName } from "../models/compact.js";
+export const addCompactTable = {
+    hash: "003-add-compact-table",
+    sql: (module) => [
+        sql `\
+CREATE TABLE IF NOT EXISTS ${sql.identifier(compactTableName(module))} (
+  "id" TEXT NOT NULL PRIMARY KEY,
+  "createdAt" DATETIME NOT NULL,
+  "updatedAt" DATETIME NOT NULL,
+  "path" TEXT NOT NULL,
+  "sessionId" TEXT,
+  "userId" TEXT,
+  "agentId" TEXT,
+  "metadata" JSON,
+  "content" JSON
+)
+`,
+    ],
+};

package/lib/esm/storage/models/compact.d.ts

@@ -0,0 +1,183 @@
+import type { AFSModule } from "@aigne/afs";
+export declare const compactTableName: (module: AFSModule) => string;
+export declare const compactTable: (module: AFSModule) => import("@aigne/sqlite").SQLiteTableWithColumns<{
+    name: string;
+    schema: undefined;
+    columns: {
+        id: import("@aigne/sqlite").SQLiteColumn<{
+            name: "id";
+            tableName: string;
+            dataType: "string";
+            columnType: "SQLiteText";
+            data: string;
+            driverParam: string;
+            notNull: true;
+            hasDefault: true;
+            isPrimaryKey: true;
+            isAutoincrement: false;
+            hasRuntimeDefault: true;
+            enumValues: [string, ...string[]];
+            baseColumn: never;
+            identity: undefined;
+            generated: undefined;
+        }, {}, {
+            length: number | undefined;
+        }>;
+        createdAt: import("@aigne/sqlite").SQLiteColumn<{
+            name: "createdAt";
+            tableName: string;
+            dataType: "custom";
+            columnType: "SQLiteCustomColumn";
+            data: Date;
+            driverParam: string;
+            notNull: true;
+            hasDefault: true;
+            isPrimaryKey: false;
+            isAutoincrement: false;
+            hasRuntimeDefault: true;
+            enumValues: undefined;
+            baseColumn: never;
+            identity: undefined;
+            generated: undefined;
+        }, {}, {
+            sqliteColumnBuilderBrand: "SQLiteCustomColumnBuilderBrand";
+        }>;
+        updatedAt: import("@aigne/sqlite").SQLiteColumn<{
+            name: "updatedAt";
+            tableName: string;
+            dataType: "custom";
+            columnType: "SQLiteCustomColumn";
+            data: Date;
+            driverParam: string;
+            notNull: true;
+            hasDefault: true;
+            isPrimaryKey: false;
+            isAutoincrement: false;
+            hasRuntimeDefault: true;
+            enumValues: undefined;
+            baseColumn: never;
+            identity: undefined;
+            generated: undefined;
+        }, {}, {
+            sqliteColumnBuilderBrand: "SQLiteCustomColumnBuilderBrand";
+        }>;
+        path: import("@aigne/sqlite").SQLiteColumn<{
+            name: "path";
+            tableName: string;
+            dataType: "string";
+            columnType: "SQLiteText";
+            data: string;
+            driverParam: string;
+            notNull: true;
+            hasDefault: false;
+            isPrimaryKey: false;
+            isAutoincrement: false;
+            hasRuntimeDefault: false;
+            enumValues: [string, ...string[]];
+            baseColumn: never;
+            identity: undefined;
+            generated: undefined;
+        }, {}, {
+            length: number | undefined;
+        }>;
+        userId: import("@aigne/sqlite").SQLiteColumn<{
+            name: "userId";
+            tableName: string;
+            dataType: "string";
+            columnType: "SQLiteText";
+            data: string;
+            driverParam: string;
+            notNull: false;
+            hasDefault: false;
+            isPrimaryKey: false;
+            isAutoincrement: false;
+            hasRuntimeDefault: false;
+            enumValues: [string, ...string[]];
+            baseColumn: never;
+            identity: undefined;
+            generated: undefined;
+        }, {}, {
+            length: number | undefined;
+        }>;
+        sessionId: import("@aigne/sqlite").SQLiteColumn<{
+            name: "sessionId";
+            tableName: string;
+            dataType: "string";
+            columnType: "SQLiteText";
+            data: string;
+            driverParam: string;
+            notNull: false;
+            hasDefault: false;
+            isPrimaryKey: false;
+            isAutoincrement: false;
+            hasRuntimeDefault: false;
+            enumValues: [string, ...string[]];
+            baseColumn: never;
+            identity: undefined;
+            generated: undefined;
+        }, {}, {
+            length: number | undefined;
+        }>;
+        agentId: import("@aigne/sqlite").SQLiteColumn<{
+            name: "agentId";
+            tableName: string;
+            dataType: "string";
+            columnType: "SQLiteText";
+            data: string;
+            driverParam: string;
+            notNull: false;
+            hasDefault: false;
+            isPrimaryKey: false;
+            isAutoincrement: false;
+            hasRuntimeDefault: false;
+            enumValues: [string, ...string[]];
+            baseColumn: never;
+            identity: undefined;
+            generated: undefined;
+        }, {}, {
+            length: number | undefined;
+        }>;
+        metadata: import("@aigne/sqlite").SQLiteColumn<{
+            name: string;
+            tableName: string;
+            dataType: "custom";
+            columnType: "SQLiteCustomColumn";
+            data: {
+                type?: string;
+                latestEntryId?: string;
+            } & Record<string, unknown>;
+            driverParam: string;
+            notNull: false;
+            hasDefault: false;
+            isPrimaryKey: false;
+            isAutoincrement: false;
+            hasRuntimeDefault: false;
+            enumValues: undefined;
+            baseColumn: never;
+            identity: undefined;
+            generated: undefined;
+        }, {}, {
+            sqliteColumnBuilderBrand: "SQLiteCustomColumnBuilderBrand";
+        }>;
+        content: import("@aigne/sqlite").SQLiteColumn<{
+            name: string;
+            tableName: string;
+            dataType: "custom";
+            columnType: "SQLiteCustomColumn";
+            data: unknown;
+            driverParam: string;
+            notNull: false;
+            hasDefault: false;
+            isPrimaryKey: false;
+            isAutoincrement: false;
+            hasRuntimeDefault: false;
+            enumValues: undefined;
+            baseColumn: never;
+            identity: undefined;
+            generated: undefined;
+        }, {}, {
+            sqliteColumnBuilderBrand: "SQLiteCustomColumnBuilderBrand";
+        }>;
+    };
+    dialect: "sqlite";
+}>;