@secure-exec/core 0.2.0-rc.2 → 0.2.1-rc.1

package/dist/test/vfs-conformance.d.ts

@@ -0,0 +1,65 @@
+/**
+ * Shared VFS conformance test suite.
+ *
+ * Every VirtualFileSystem implementation must pass the core tests in this suite.
+ * Optional test groups are gated on capability flags declared in the config.
+ *
+ * Usage:
+ *
+ * ```typescript
+ * import { defineVfsConformanceTests } from "@secure-exec/core/test/vfs-conformance";
+ *
+ * defineVfsConformanceTests({
+ *   name: "MyDriver",
+ *   createFs: () => createMyDriver(),
+ *   cleanup: () => cleanupMyDriver(),
+ *   capabilities: {
+ *     symlinks: true,
+ *     hardLinks: true,
+ *     permissions: true,
+ *     utimes: true,
+ *     truncate: true,
+ *     pread: true,
+ *     pwrite: true,
+ *     mkdir: true,
+ *     removeDir: true,
+ *     fsync: false,
+ *     copy: false,
+ *     readDirStat: false,
+ *   },
+ * });
+ * ```
+ *
+ * For chunked VFS implementations, pass `inlineThreshold` and `chunkSize` to
+ * enable edge case tests at storage tier boundaries.
+ */
+import type { VirtualFileSystem } from "../kernel/vfs.js";
+export interface VfsConformanceCapabilities {
+    symlinks: boolean;
+    hardLinks: boolean;
+    permissions: boolean;
+    utimes: boolean;
+    truncate: boolean;
+    pread: boolean;
+    pwrite: boolean;
+    mkdir: boolean;
+    removeDir: boolean;
+    fsync: boolean;
+    copy: boolean;
+    readDirStat: boolean;
+}
+export interface VfsConformanceConfig {
+    /** Human-readable name shown in the describe block. */
+    name: string;
+    /** Create a fresh VFS instance for each test. */
+    createFs: () => Promise<VirtualFileSystem> | VirtualFileSystem;
+    /** Optional teardown called after each test. */
+    cleanup?: () => Promise<void>;
+    /** Which optional capabilities the driver supports. */
+    capabilities: VfsConformanceCapabilities;
+    /** Inline threshold in bytes. Enables boundary edge case tests. */
+    inlineThreshold?: number;
+    /** Chunk size in bytes. Enables boundary edge case tests. */
+    chunkSize?: number;
+}
+export declare function defineVfsConformanceTests(config: VfsConformanceConfig): void;