@cuylabs/agent-session-store-file 5.0.0

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,12 @@
+# @cuylabs/agent-session-store-file
+
+JSONL-backed `SessionStore` implementation for `@cuylabs/agent-core`.
+
+```ts
+import { SessionManager } from "@cuylabs/agent-core/sessions";
+import { FileSessionStore } from "@cuylabs/agent-session-store-file";
+
+const sessions = new SessionManager(
+  new FileSessionStore({ directory: ".sessions" }),
+);
+```

package/dist/index.d.ts

@@ -0,0 +1,73 @@
+import { SessionStore, SessionHeader, SessionEntry, FileEntry, SessionInfo } from '@cuylabs/agent-core/sessions';
+
+interface FileSessionStoreOptions {
+    directory: string;
+    extension?: string;
+    cache?: boolean;
+}
+
+declare class FileSessionStore implements SessionStore {
+    private readonly directory;
+    private readonly extension;
+    private readonly useCache;
+    private cache;
+    private initialized;
+    constructor(options: FileSessionStoreOptions);
+    private ensureDir;
+    private getPath;
+    private getEntries;
+    create(header: SessionHeader): Promise<void>;
+    append(sessionId: string, entry: SessionEntry): Promise<void>;
+    appendBatch(sessionId: string, entries: SessionEntry[]): Promise<void>;
+    read(sessionId: string): Promise<FileEntry[]>;
+    delete(sessionId: string): Promise<boolean>;
+    exists(sessionId: string): Promise<boolean>;
+    list(): Promise<SessionInfo[]>;
+    clear(): Promise<void>;
+    flushCache(): void;
+    reload(sessionId: string): Promise<FileEntry[]>;
+    listIds(): Promise<string[]>;
+    getStats(sessionId: string): Promise<{
+        size: number;
+        mtime: Date;
+    } | null>;
+}
+
+/**
+ * Default paths for storage
+ *
+ * Follows platform conventions:
+ * - macOS: ~/.cuylabs/
+ * - Linux: $XDG_DATA_HOME/cuylabs/ or ~/.local/share/cuylabs/
+ * - Windows: %APPDATA%/cuylabs/
+ *
+ * Project identification:
+ * - Uses git root commit hash for git repos
+ * - Falls back to encoded path for non-git directories
+ */
+/**
+ * Get the default data directory for cuylabs
+ */
+declare function getDataDir(appName?: string): string;
+/**
+ * Get the default sessions directory
+ */
+declare function getSessionsDir(appName?: string): string;
+/**
+ * Get the git root commit hash for a directory.
+ * This is stable across machines and identifies the project uniquely.
+ * Returns null if not a git repo.
+ */
+declare function getGitRootHash(cwd: string): string | null;
+/**
+ * Get a short project ID for a directory.
+ * - For git repos: uses first 12 chars of root commit hash
+ * - For non-git: uses encoded path
+ */
+declare function getProjectId(cwd: string): string;
+/**
+ * Get sessions directory for a specific project/cwd
+ */
+declare function getProjectSessionsDir(cwd: string, appName?: string): string;
+
+export { FileSessionStore, type FileSessionStoreOptions, getDataDir, getGitRootHash, getProjectId, getProjectSessionsDir, getSessionsDir };

package/dist/index.js

@@ -0,0 +1,277 @@
+// src/store.ts
+import { extractSessionInfo } from "@cuylabs/agent-core/sessions";
+
+// src/helpers.ts
+import {
+  appendFile,
+  mkdir,
+  readFile,
+  readdir,
+  stat,
+  unlink,
+  writeFile
+} from "fs/promises";
+import { existsSync } from "fs";
+import { basename, join } from "path";
+import {
+  parseJSONL,
+  toJSONL,
+  toJSONLBatch
+} from "@cuylabs/agent-core/sessions";
+async function ensureStorageDirectory(directory) {
+  if (!existsSync(directory)) {
+    await mkdir(directory, { recursive: true });
+  }
+}
+function getSessionFilePath(directory, extension, sessionId) {
+  const safeId = sessionId.replace(/[^a-zA-Z0-9-_]/g, "_");
+  const needsHash = safeId !== sessionId;
+  if (needsHash) {
+    let hash = 2166136261;
+    for (let i = 0; i < sessionId.length; i++) {
+      hash ^= sessionId.charCodeAt(i);
+      hash = hash * 16777619 >>> 0;
+    }
+    const suffix = hash.toString(16).padStart(8, "0");
+    return join(directory, `${safeId}_${suffix}${extension}`);
+  }
+  return join(directory, `${safeId}${extension}`);
+}
+async function loadEntriesFromDisk(filePath, sessionId) {
+  try {
+    const content = await readFile(filePath, "utf-8");
+    return parseJSONL(content);
+  } catch (error) {
+    if (error.code === "ENOENT") {
+      throw new Error(`Session not found: ${sessionId}`);
+    }
+    throw error;
+  }
+}
+async function createSessionFile(filePath, header) {
+  await writeFile(filePath, toJSONL(header), "utf-8");
+}
+async function appendSessionEntry(filePath, entry) {
+  await appendFile(filePath, toJSONL(entry), "utf-8");
+}
+async function appendSessionEntries(filePath, entries) {
+  await appendFile(filePath, toJSONLBatch(entries), "utf-8");
+}
+function sessionFileExists(filePath) {
+  return existsSync(filePath);
+}
+async function deleteSessionFile(filePath) {
+  if (!existsSync(filePath)) {
+    return false;
+  }
+  try {
+    await unlink(filePath);
+    return true;
+  } catch {
+    return false;
+  }
+}
+async function listSessionIds(directory, extension) {
+  try {
+    const files = await readdir(directory);
+    return files.filter((file) => file.endsWith(extension)).map((file) => basename(file, extension));
+  } catch {
+    return [];
+  }
+}
+async function clearSessionFiles(directory, extension) {
+  try {
+    const files = await readdir(directory);
+    await Promise.all(
+      files.filter((file) => file.endsWith(extension)).map((file) => unlink(join(directory, file)).catch(() => {
+      }))
+    );
+  } catch {
+  }
+}
+async function getSessionFileStats(filePath) {
+  try {
+    const info = await stat(filePath);
+    return {
+      size: info.size,
+      mtime: info.mtime
+    };
+  } catch {
+    return null;
+  }
+}
+
+// src/store.ts
+var FileSessionStore = class {
+  directory;
+  extension;
+  useCache;
+  cache = /* @__PURE__ */ new Map();
+  initialized = false;
+  constructor(options) {
+    this.directory = options.directory;
+    this.extension = options.extension ?? ".jsonl";
+    this.useCache = options.cache ?? true;
+  }
+  async ensureDir() {
+    if (this.initialized) return;
+    await ensureStorageDirectory(this.directory);
+    this.initialized = true;
+  }
+  getPath(sessionId) {
+    return getSessionFilePath(this.directory, this.extension, sessionId);
+  }
+  async getEntries(sessionId) {
+    if (this.useCache && this.cache.has(sessionId)) {
+      return this.cache.get(sessionId);
+    }
+    const entries = await loadEntriesFromDisk(
+      this.getPath(sessionId),
+      sessionId
+    );
+    if (this.useCache) {
+      this.cache.set(sessionId, entries);
+    }
+    return entries;
+  }
+  async create(header) {
+    await this.ensureDir();
+    const filePath = this.getPath(header.id);
+    if (sessionFileExists(filePath)) {
+      throw new Error(`Session already exists: ${header.id}`);
+    }
+    await createSessionFile(filePath, header);
+    if (this.useCache) {
+      this.cache.set(header.id, [header]);
+    }
+  }
+  async append(sessionId, entry) {
+    await this.ensureDir();
+    const filePath = this.getPath(sessionId);
+    if (!sessionFileExists(filePath)) {
+      throw new Error(`Session not found: ${sessionId}`);
+    }
+    await appendSessionEntry(filePath, entry);
+    if (this.useCache) {
+      this.cache.get(sessionId)?.push(entry);
+    }
+  }
+  async appendBatch(sessionId, entries) {
+    if (entries.length === 0) return;
+    await this.ensureDir();
+    const filePath = this.getPath(sessionId);
+    if (!sessionFileExists(filePath)) {
+      throw new Error(`Session not found: ${sessionId}`);
+    }
+    await appendSessionEntries(filePath, entries);
+    if (this.useCache) {
+      this.cache.get(sessionId)?.push(...entries);
+    }
+  }
+  async read(sessionId) {
+    await this.ensureDir();
+    return [...await this.getEntries(sessionId)];
+  }
+  async delete(sessionId) {
+    this.cache.delete(sessionId);
+    return deleteSessionFile(this.getPath(sessionId));
+  }
+  async exists(sessionId) {
+    if (this.useCache && this.cache.has(sessionId)) {
+      return true;
+    }
+    return sessionFileExists(this.getPath(sessionId));
+  }
+  async list() {
+    await this.ensureDir();
+    const infos = [];
+    for (const sessionId of await listSessionIds(
+      this.directory,
+      this.extension
+    )) {
+      try {
+        const info = extractSessionInfo(
+          await this.getEntries(sessionId),
+          this.getPath(sessionId)
+        );
+        if (info) {
+          infos.push(info);
+        }
+      } catch {
+      }
+    }
+    infos.sort((a, b) => b.createdAt.getTime() - a.createdAt.getTime());
+    return infos;
+  }
+  async clear() {
+    this.cache.clear();
+    await clearSessionFiles(this.directory, this.extension);
+  }
+  flushCache() {
+    this.cache.clear();
+  }
+  async reload(sessionId) {
+    this.cache.delete(sessionId);
+    return this.read(sessionId);
+  }
+  async listIds() {
+    await this.ensureDir();
+    return listSessionIds(this.directory, this.extension);
+  }
+  async getStats(sessionId) {
+    return getSessionFileStats(this.getPath(sessionId));
+  }
+};
+
+// src/paths.ts
+import { homedir } from "os";
+import { join as join2 } from "path";
+import { execSync } from "child_process";
+function getDataDir(appName = "cuylabs") {
+  const platform = process.platform;
+  if (platform === "darwin") {
+    return join2(homedir(), `.${appName}`);
+  }
+  if (platform === "win32") {
+    return join2(
+      process.env.APPDATA || join2(homedir(), "AppData", "Roaming"),
+      appName
+    );
+  }
+  const xdgData = process.env.XDG_DATA_HOME || join2(homedir(), ".local", "share");
+  return join2(xdgData, appName);
+}
+function getSessionsDir(appName = "cuylabs") {
+  return join2(getDataDir(appName), "sessions");
+}
+function getGitRootHash(cwd) {
+  try {
+    const result = execSync("git rev-list --max-parents=0 --all 2>/dev/null", {
+      cwd,
+      encoding: "utf-8"
+    });
+    const roots = result.split("\n").filter(Boolean).map((s) => s.trim()).sort();
+    return roots[0] || null;
+  } catch {
+    return null;
+  }
+}
+function getProjectId(cwd) {
+  const gitHash = getGitRootHash(cwd);
+  if (gitHash) {
+    return gitHash.slice(0, 12);
+  }
+  return cwd.replace(/^\//, "").replace(/[/\\:]/g, "-").replace(/\s+/g, "-").toLowerCase().slice(-50);
+}
+function getProjectSessionsDir(cwd, appName = "cuylabs") {
+  const projectId = getProjectId(cwd);
+  return join2(getSessionsDir(appName), projectId);
+}
+export {
+  FileSessionStore,
+  getDataDir,
+  getGitRootHash,
+  getProjectId,
+  getProjectSessionsDir,
+  getSessionsDir
+};

package/package.json

@@ -0,0 +1,56 @@
+{
+  "name": "@cuylabs/agent-session-store-file",
+  "version": "5.0.0",
+  "description": "File-backed session store for @cuylabs/agent-core",
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "default": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "dependencies": {
+    "@cuylabs/agent-core": "^5.0.0"
+  },
+  "devDependencies": {
+    "@types/node": "^22.0.0",
+    "tsup": "^8.0.0",
+    "typescript": "^5.7.0",
+    "vitest": "^4.0.18"
+  },
+  "keywords": [
+    "agent",
+    "session",
+    "store",
+    "file",
+    "jsonl"
+  ],
+  "author": "cuylabs",
+  "license": "Apache-2.0",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/cuylabs-ai/agents-ts.git",
+    "directory": "packages/agent-session-store-file"
+  },
+  "engines": {
+    "node": ">=20"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "tsup src/index.ts --format esm --dts --clean",
+    "dev": "tsup src/index.ts --format esm --dts --watch",
+    "typecheck": "tsc --noEmit",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "clean": "rm -rf dist"
+  }
+}