@lix-js/storage-filesystem 0.0.0 → 0.12.0

package/README.md

@@ -1,4 +1,35 @@
-# `@lix-js/storage-filesystem`
+# `lix-storage-filesystem`
 
-This `0.0.0` package is an inert registry bootstrap. Install a released version
-of `@lix-js/storage-filesystem` instead.
+Filesystem-backed storage for Lix. The Rust crate and JavaScript package expose
+the same adapter with independently versioned releases.
+
+## JavaScript
+
+```ts
+import { openLix } from "@lix-js/sdk";
+import { FilesystemStorage } from "@lix-js/storage-filesystem";
+
+const storage = new FilesystemStorage({ path: "./repository" });
+const lix = await openLix({ storage });
+```
+
+The whole repository is synchronized by default. Pass `syncAllFiles: false`
+and use `storage.importPaths(paths)` for selective synchronization.
+
+## Rust
+
+```rust
+use lix::open_lix;
+use lix_storage_filesystem::FilesystemStorage;
+
+# async fn example() -> Result<(), lix::LixError> {
+let storage = FilesystemStorage::new("./repository").open()?;
+let lix = open_lix().with_storage(storage.clone()).await?;
+storage.start_sync(&lix).await?;
+# Ok(())
+# }
+```
+
+The storage owns synchronization until `storage.stop_sync().await?` or until
+the final storage/repository instance is dropped. Explicitly stopping is useful
+for tests and before immediately reopening the same path.

package/dist/index.d.ts

@@ -0,0 +1,38 @@
+/** Options for opening filesystem-backed Lix storage. */
+export type FilesystemStorageOptions = {
+    /** Directory synchronized with the Lix repository. */
+    path: string;
+    /** Whether every file below `path` is synchronized. Defaults to `true`. */
+    syncAllFiles?: boolean;
+};
+type FilesystemStorageConnection = {
+    importFilesystemPaths(paths: string[]): Promise<void>;
+    syncDiskToLix(): Promise<void>;
+};
+/**
+ * Filesystem-backed storage for Lix.
+ *
+ * Pass an instance to `openLix({ storage })`. The Rust
+ * `lix-storage-filesystem` adapter performs the actual storage and sync work.
+ */
+export declare class FilesystemStorage {
+    #private;
+    readonly path: string;
+    readonly syncAllFiles: boolean;
+    readonly lixStorage: {
+        readonly version: 1;
+        readonly config: {
+            readonly kind: "filesystem";
+            readonly path: string;
+            readonly syncAllFiles: boolean;
+        };
+        connect(connection: FilesystemStorageConnection | undefined): void;
+    };
+    constructor(options: FilesystemStorageOptions);
+    /** Import selected filesystem paths into the open Lix repository. */
+    importPaths(paths: readonly string[]): Promise<void>;
+    /** Immediately synchronize current disk changes into Lix. */
+    syncDiskToLix(): Promise<void>;
+}
+export {};
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../js/index.ts"],"names":[],"mappings":"AAAA,yDAAyD;AACzD,MAAM,MAAM,wBAAwB,GAAG;IACtC,sDAAsD;IACtD,IAAI,EAAE,MAAM,CAAC;IACb,2EAA2E;IAC3E,YAAY,CAAC,EAAE,OAAO,CAAC;CACvB,CAAC;AAEF,KAAK,2BAA2B,GAAG;IAClC,qBAAqB,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACtD,aAAa,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;CAC/B,CAAC;AAEF;;;;;GAKG;AACH,qBAAa,iBAAiB;;IAC7B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,YAAY,EAAE,OAAO,CAAC;IAG/B,QAAQ,CAAC,UAAU,EAAE;QACpB,QAAQ,CAAC,OAAO,EAAE,CAAC,CAAC;QACpB,QAAQ,CAAC,MAAM,EAAE;YAChB,QAAQ,CAAC,IAAI,EAAE,YAAY,CAAC;YAC5B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;YACtB,QAAQ,CAAC,YAAY,EAAE,OAAO,CAAC;SAC/B,CAAC;QACF,OAAO,CAAC,UAAU,EAAE,2BAA2B,GAAG,SAAS,GAAG,IAAI,CAAC;KACnE,CAAC;gBAEU,OAAO,EAAE,wBAAwB;IA6B7C,qEAAqE;IAC/D,WAAW,CAAC,KAAK,EAAE,SAAS,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAmB1D,6DAA6D;IACvD,aAAa,IAAI,OAAO,CAAC,IAAI,CAAC;CAapC"}

package/dist/index.js

@@ -0,0 +1,65 @@
+/**
+ * Filesystem-backed storage for Lix.
+ *
+ * Pass an instance to `openLix({ storage })`. The Rust
+ * `lix-storage-filesystem` adapter performs the actual storage and sync work.
+ */
+export class FilesystemStorage {
+    path;
+    syncAllFiles;
+    #connection;
+    lixStorage;
+    constructor(options) {
+        if (!options || typeof options !== "object") {
+            throw new TypeError("FilesystemStorage options must be an object");
+        }
+        if (typeof options.path !== "string" || options.path.length === 0) {
+            throw new TypeError("FilesystemStorage requires a non-empty path");
+        }
+        if (options.syncAllFiles !== undefined &&
+            typeof options.syncAllFiles !== "boolean") {
+            throw new TypeError("FilesystemStorage syncAllFiles must be a boolean");
+        }
+        this.path = options.path;
+        this.syncAllFiles = options.syncAllFiles ?? true;
+        this.lixStorage = {
+            version: 1,
+            config: {
+                kind: "filesystem",
+                path: this.path,
+                syncAllFiles: this.syncAllFiles,
+            },
+            connect: (connection) => {
+                this.#connection = connection;
+            },
+        };
+    }
+    /** Import selected filesystem paths into the open Lix repository. */
+    async importPaths(paths) {
+        if (!Array.isArray(paths)) {
+            throw new TypeError("importPaths() paths must be an array");
+        }
+        for (const path of paths) {
+            if (typeof path !== "string" || path.length === 0) {
+                throw new TypeError("importPaths() paths must contain non-empty strings");
+            }
+            if (path.endsWith("/")) {
+                throw new TypeError("importPaths() paths must not end with a trailing slash");
+            }
+        }
+        await this.#requireConnection("importPaths").importFilesystemPaths([...paths]);
+    }
+    /** Immediately synchronize current disk changes into Lix. */
+    async syncDiskToLix() {
+        await this.#requireConnection("syncDiskToLix").syncDiskToLix();
+    }
+    #requireConnection(operation) {
+        if (this.#connection)
+            return this.#connection;
+        const error = new Error(`FilesystemStorage.${operation}() requires an open Lix using this storage`);
+        error.name = "LixError";
+        error.code = "LIX_FILESYSTEM_STORAGE_NOT_OPEN";
+        throw error;
+    }
+}
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../js/index.ts"],"names":[],"mappings":"AAaA;;;;;GAKG;AACH,MAAM,OAAO,iBAAiB;IACpB,IAAI,CAAS;IACb,YAAY,CAAU;IAC/B,WAAW,CAA0C;IAE5C,UAAU,CAQjB;IAEF,YAAY,OAAiC;QAC5C,IAAI,CAAC,OAAO,IAAI,OAAO,OAAO,KAAK,QAAQ,EAAE,CAAC;YAC7C,MAAM,IAAI,SAAS,CAAC,6CAA6C,CAAC,CAAC;QACpE,CAAC;QACD,IAAI,OAAO,OAAO,CAAC,IAAI,KAAK,QAAQ,IAAI,OAAO,CAAC,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACnE,MAAM,IAAI,SAAS,CAAC,6CAA6C,CAAC,CAAC;QACpE,CAAC;QACD,IACC,OAAO,CAAC,YAAY,KAAK,SAAS;YAClC,OAAO,OAAO,CAAC,YAAY,KAAK,SAAS,EACxC,CAAC;YACF,MAAM,IAAI,SAAS,CAAC,kDAAkD,CAAC,CAAC;QACzE,CAAC;QAED,IAAI,CAAC,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;QACzB,IAAI,CAAC,YAAY,GAAG,OAAO,CAAC,YAAY,IAAI,IAAI,CAAC;QACjD,IAAI,CAAC,UAAU,GAAG;YACjB,OAAO,EAAE,CAAC;YACV,MAAM,EAAE;gBACP,IAAI,EAAE,YAAY;gBAClB,IAAI,EAAE,IAAI,CAAC,IAAI;gBACf,YAAY,EAAE,IAAI,CAAC,YAAY;aAC/B;YACD,OAAO,EAAE,CAAC,UAAU,EAAE,EAAE;gBACvB,IAAI,CAAC,WAAW,GAAG,UAAU,CAAC;YAC/B,CAAC;SACD,CAAC;IACH,CAAC;IAED,qEAAqE;IACrE,KAAK,CAAC,WAAW,CAAC,KAAwB;QACzC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;YAC3B,MAAM,IAAI,SAAS,CAAC,sCAAsC,CAAC,CAAC;QAC7D,CAAC;QACD,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;YAC1B,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBACnD,MAAM,IAAI,SAAS,CAClB,oDAAoD,CACpD,CAAC;YACH,CAAC;YACD,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;gBACxB,MAAM,IAAI,SAAS,CAClB,wDAAwD,CACxD,CAAC;YACH,CAAC;QACF,CAAC;QACD,MAAM,IAAI,CAAC,kBAAkB,CAAC,aAAa,CAAC,CAAC,qBAAqB,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC;IAChF,CAAC;IAED,6DAA6D;IAC7D,KAAK,CAAC,aAAa;QAClB,MAAM,IAAI,CAAC,kBAAkB,CAAC,eAAe,CAAC,CAAC,aAAa,EAAE,CAAC;IAChE,CAAC;IAED,kBAAkB,CAAC,SAAiB;QACnC,IAAI,IAAI,CAAC,WAAW;YAAE,OAAO,IAAI,CAAC,WAAW,CAAC;QAC9C,MAAM,KAAK,GAAG,IAAI,KAAK,CACtB,qBAAqB,SAAS,4CAA4C,CAC9C,CAAC;QAC9B,KAAK,CAAC,IAAI,GAAG,UAAU,CAAC;QACxB,KAAK,CAAC,IAAI,GAAG,iCAAiC,CAAC;QAC/C,MAAM,KAAK,CAAC;IACb,CAAC;CACD"}

package/package.json

@@ -1,21 +1,35 @@
 {
 	"name": "@lix-js/storage-filesystem",
-	"version": "0.0.0",
-	"description": "Bootstrap placeholder for the Lix filesystem storage package.",
-	"license": "MIT",
 	"type": "module",
+	"version": "0.12.0",
+	"license": "MIT",
 	"repository": {
 		"type": "git",
 		"url": "https://github.com/opral/lix",
 		"directory": "packages/storage-filesystem"
 	},
-	"exports": "./index.js",
+	"exports": {
+		".": {
+			"types": "./dist/index.d.ts",
+			"default": "./dist/index.js"
+		}
+	},
 	"files": [
-		"index.js",
+		"dist",
 		"README.md"
 	],
-	"publishConfig": {
-		"access": "public",
-		"tag": "bootstrap"
+	"scripts": {
+		"build": "npm run clean && tsc -p tsconfig.json",
+		"clean": "node -e \"import('node:fs/promises').then(({ rm }) => rm('dist', { recursive: true, force: true }))\"",
+		"test": "vitest run",
+		"typecheck": "tsc -p tsconfig.test.json --noEmit"
+	},
+	"peerDependencies": {
+		"@lix-js/sdk": "0.12.0"
+	},
+	"devDependencies": {
+		"@types/node": "^24.10.2",
+		"typescript": "^5.5.4",
+		"vitest": "4.1.10"
 	}
 }

package/index.js

@@ -1,3 +0,0 @@
-throw new Error(
-	"@lix-js/storage-filesystem@0.0.0 is an inert registry bootstrap; install a released version instead.",
-);