@rljson/fs-agent 0.0.2 → 0.0.3

package/README.contributors.md

@@ -13,6 +13,10 @@ found in the LICENSE file in the root of this package.
 - [Administrate](#administrate)
 - [Fast Coding](#fast-coding)
 
+## ⚠️ Important: ESLint Version
+
+**Do NOT update ESLint to v10.x** - The package is pinned to `eslint ~9.39.2` because `eslint-plugin-tsdoc@0.5.0` is incompatible with ESLint v10's API changes (specifically `context.getSourceCode()` was removed). Updating to v10 will break the build.
+
 ## Prepare
 
 Read [prepare.md](doc/prepare.md)

package/dist/README.contributors.md

@@ -13,6 +13,10 @@ found in the LICENSE file in the root of this package.
 - [Administrate](#administrate)
 - [Fast Coding](#fast-coding)
 
+## ⚠️ Important: ESLint Version
+
+**Do NOT update ESLint to v10.x** - The package is pinned to `eslint ~9.39.2` because `eslint-plugin-tsdoc@0.5.0` is incompatible with ESLint v10's API changes (specifically `context.getSourceCode()` was removed). Updating to v10 will break the build.
+
 ## Prepare
 
 Read [prepare.md](doc/prepare.md)

package/dist/client-server/example-from-client.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/client-server/live-client-server-socketio.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/fs-agent.d.ts

@@ -173,6 +173,32 @@ export declare class FsAgent {
      * @returns Function to stop watching
      */
     syncFromDb(db: Db, connector: Connector, treeKey: string, restoreOptions?: RestoreOptions): Promise<() => void>;
+    /**
+     * Creates a fully configured FsAgent from a Client instance.
+     * This factory method provides a simplified API where sync methods don't require
+     * db, connector, and treeKey parameters - they are stored internally.
+     * @param filePath - Directory path to sync
+     * @param treeKey - Tree table key (route will be `/${treeKey}`)
+     * @param client - Client instance with io and bs properties
+     * @param socket - Socket instance for connector communication
+     * @param options - Optional FsAgent options (db and treeKey are set automatically)
+     * @returns Configured FsAgent instance with simplified sync API
+     * @example
+     * ```typescript
+     * const agent = await FsAgent.fromClient('./my-folder', 'sharedTree', client, socket);
+     * // Simplified sync methods - no db/connector/treeKey needed
+     * await agent.syncToDbSimple({ notify: true });
+     * await agent.syncFromDbSimple({ cleanTarget: true });
+     * // Original methods still work
+     * await agent.syncToDb(db, connector, treeKey, { notify: true });
+     * ```
+     */
+    static fromClient(filePath: string, treeKey: string, client: any, // Client type from \@rljson/server
+    socket: any, // Socket type from \@rljson/io
+    options?: Omit<FsAgentOptions, 'db' | 'treeKey'>): Promise<FsAgent & {
+        syncToDbSimple: (options?: StoreFsTreeOptions) => Promise<() => void>;
+        syncFromDbSimple: (options?: RestoreOptions) => Promise<() => void>;
+    }>;
     /** Example instance for test purposes */
     static get example(): FsAgent;
 }