@effect-vfs/core 0.1.0 → 0.3.0

package/dist/internal/virtualFileSystem.d.ts

@@ -0,0 +1,290 @@
+import * as ByteSize from "effect/ByteSize";
+import * as Context from "effect/Context";
+import * as Effect from "effect/Effect";
+import * as Schema from "effect/Schema";
+import { BytePath } from "../BytePath.js";
+import { ImageError, type Snapshot } from "../Snapshot.js";
+import type { Caller, OverlayVolume, RelativeOptions, Volume } from "../VirtualFileSystem.js";
+import * as Image from "./image.js";
+import { ConfigurationError, FsCode as FsCodeSchema, FsError } from "./virtualFileSystem/errors.js";
+/** @internal */
+export declare const VolumeId: unique symbol;
+/** @internal */
+export declare const CallerId: unique symbol;
+/** @internal */
+export declare const FileHandleId: unique symbol;
+/** @internal */
+export declare const DirectoryHandleId: unique symbol;
+/** @internal */
+export declare const ObjectReferenceId: unique symbol;
+/** @internal */
+export { ConfigurationError, FsCodeSchema as FsCode, FsError };
+/** @internal */
+export declare const Mode: Schema.Natural;
+/** @internal */
+export declare const Identity: Schema.Struct<{
+    readonly uid: Schema.Natural;
+    readonly gid: Schema.Natural;
+    readonly groups: Schema.$Array<Schema.Natural>;
+    readonly privileged: Schema.Boolean;
+}>;
+/** @internal */
+export type Identity = typeof Identity.Type;
+/** @internal */
+export declare const RootCallerOptions: Schema.Struct<{
+    readonly identity: Schema.optionalKey<Schema.Struct<{
+        readonly uid: Schema.Natural;
+        readonly gid: Schema.Natural;
+        readonly groups: Schema.$Array<Schema.Natural>;
+        readonly privileged: Schema.Boolean;
+    }>>;
+    readonly umask: Schema.optionalKey<Schema.Natural>;
+}>;
+/** @internal */
+export type RootCallerOptions = typeof RootCallerOptions.Type;
+/** @internal */
+export declare const VolumeOptions: Schema.Struct<{
+    readonly maxEntries: Schema.optionalKey<Schema.Natural>;
+    readonly maxBytes: Schema.optionalKey<Schema.ByteSize>;
+    readonly maxFileBytes: Schema.optionalKey<Schema.ByteSize>;
+    readonly maxPathBytes: Schema.optionalKey<Schema.ByteSize>;
+}>;
+/** @internal */
+export type VolumeOptions = typeof VolumeOptions.Type;
+/** @internal */
+export declare const Timestamp: Schema.BigInt;
+/** @internal */
+export declare const Metadata: Schema.Struct<{
+    readonly kind: Schema.Literals<readonly ["directory", "file", "symlink"]>;
+    readonly ino: Schema.BigInt;
+    readonly nlink: Schema.Natural;
+    readonly size: Schema.BigInt;
+    readonly uid: Schema.Natural;
+    readonly gid: Schema.Natural;
+    readonly mode: Schema.Natural;
+    readonly atimeNs: Schema.BigInt;
+    readonly mtimeNs: Schema.BigInt;
+    readonly ctimeNs: Schema.BigInt;
+    readonly birthtimeNs: Schema.BigInt;
+}>;
+/** @internal */
+export type Metadata = typeof Metadata.Type;
+/** @internal */
+export declare const OwnerUpdate: Schema.Struct<{
+    readonly uid: Schema.optionalKey<Schema.Natural>;
+    readonly gid: Schema.optionalKey<Schema.Natural>;
+}>;
+/** @internal */
+export type OwnerUpdate = typeof OwnerUpdate.Type;
+/** @internal */
+export declare const TimeUpdate: Schema.Union<readonly [Schema.Struct<{
+    readonly kind: Schema.Literal<"now">;
+}>, Schema.Struct<{
+    readonly kind: Schema.Literal<"omit">;
+}>, Schema.Struct<{
+    readonly kind: Schema.Literal<"value">;
+    readonly nanoseconds: Schema.BigInt;
+}>]>;
+/** @internal */
+export declare const Times: Schema.Struct<{
+    readonly access: Schema.Union<readonly [Schema.Struct<{
+        readonly kind: Schema.Literal<"now">;
+    }>, Schema.Struct<{
+        readonly kind: Schema.Literal<"omit">;
+    }>, Schema.Struct<{
+        readonly kind: Schema.Literal<"value">;
+        readonly nanoseconds: Schema.BigInt;
+    }>]>;
+    readonly modification: Schema.Union<readonly [Schema.Struct<{
+        readonly kind: Schema.Literal<"now">;
+    }>, Schema.Struct<{
+        readonly kind: Schema.Literal<"omit">;
+    }>, Schema.Struct<{
+        readonly kind: Schema.Literal<"value">;
+        readonly nanoseconds: Schema.BigInt;
+    }>]>;
+}>;
+/** @internal */
+export type Times = typeof Times.Type;
+/** @internal */
+export declare const SeekMode: Schema.Literals<readonly ["start", "current", "end", "data", "hole"]>;
+/** @internal */
+export type SeekMode = typeof SeekMode.Type;
+/** @internal */
+export declare const OpenSettings: Schema.Struct<{
+    readonly access: Schema.Literals<readonly ["read", "write", "readWrite"]>;
+    readonly create: Schema.optionalKey<Schema.Literals<readonly ["never", "ifMissing", "exclusive"]>>;
+    readonly mode: Schema.optionalKey<Schema.Natural>;
+    readonly append: Schema.optionalKey<Schema.Boolean>;
+    readonly truncate: Schema.optionalKey<Schema.Boolean>;
+    readonly followFinalSymlink: Schema.optionalKey<Schema.Boolean>;
+}>;
+/** @internal */
+export type OpenOptions = typeof OpenSettings.Type & RelativeOptions;
+/** @internal */
+export declare const WriteFileSettings: Schema.Struct<{
+    readonly access: Schema.Literals<readonly ["read", "write", "readWrite"]>;
+    readonly create: Schema.optionalKey<Schema.Literals<readonly ["never", "ifMissing", "exclusive"]>>;
+    readonly mode: Schema.optionalKey<Schema.Natural>;
+    readonly append: Schema.optionalKey<Schema.Boolean>;
+    readonly truncate: Schema.optionalKey<Schema.Boolean>;
+    readonly followFinalSymlink: Schema.optionalKey<Schema.Boolean>;
+    readonly replaceFinalSymlink: Schema.optionalKey<Schema.Boolean>;
+    readonly finalMode: Schema.optionalKey<Schema.Natural>;
+}>;
+/** @internal */
+export type WriteFileOptions = typeof WriteFileSettings.Type & RelativeOptions;
+/** @internal */
+export declare const OverlayNodeKind: Schema.Literals<readonly ["directory", "file", "symlink"]>;
+/** @internal */
+export type OverlayNodeKind = typeof OverlayNodeKind.Type;
+/** @internal */
+export declare const OverlayDifference: Schema.Literals<readonly ["content", "mode", "uid", "gid", "atimeNs", "mtimeNs", "ctimeNs", "birthtimeNs"]>;
+/** @internal */
+export type OverlayDifference = typeof OverlayDifference.Type;
+/** @internal */
+export declare const OverlayChange: Schema.Union<readonly [Schema.TaggedStruct<"Added", {
+    readonly path: Schema.declare<BytePath, BytePath>;
+    readonly kind: Schema.Literals<readonly ["directory", "file", "symlink"]>;
+}>, Schema.TaggedStruct<"Removed", {
+    readonly path: Schema.declare<BytePath, BytePath>;
+    readonly kind: Schema.Literals<readonly ["directory", "file", "symlink"]>;
+}>, Schema.TaggedStruct<"Replaced", {
+    readonly path: Schema.declare<BytePath, BytePath>;
+    readonly beforeKind: Schema.Literals<readonly ["directory", "file", "symlink"]>;
+    readonly afterKind: Schema.Literals<readonly ["directory", "file", "symlink"]>;
+    readonly differences: Schema.$Array<Schema.Literals<readonly ["content", "mode", "uid", "gid", "atimeNs", "mtimeNs", "ctimeNs", "birthtimeNs"]>>;
+}>, Schema.TaggedStruct<"Renamed", {
+    readonly from: Schema.declare<BytePath, BytePath>;
+    readonly to: Schema.declare<BytePath, BytePath>;
+    readonly kind: Schema.Literals<readonly ["directory", "file", "symlink"]>;
+    readonly differences: Schema.$Array<Schema.Literals<readonly ["content", "mode", "uid", "gid", "atimeNs", "mtimeNs", "ctimeNs", "birthtimeNs"]>>;
+}>, Schema.TaggedStruct<"Updated", {
+    readonly path: Schema.declare<BytePath, BytePath>;
+    readonly kind: Schema.Literals<readonly ["directory", "file", "symlink"]>;
+    readonly differences: Schema.$Array<Schema.Literals<readonly ["content", "mode", "uid", "gid", "atimeNs", "mtimeNs", "ctimeNs", "birthtimeNs"]>>;
+}>]>;
+/** @internal */
+export type OverlayChange = typeof OverlayChange.Type;
+/** @internal */
+export declare const OverlayChangesOptions: Schema.Struct<{
+    readonly includeTimestamps: Schema.optionalKey<Schema.Boolean>;
+}>;
+/** @internal */
+export type OverlayChangesOptions = typeof OverlayChangesOptions.Type;
+declare const CurrentFileSystem_base: Context.ServiceClass<CurrentFileSystem, "@effect-vfs/core/CurrentFileSystem", Caller>;
+/** @internal */
+export declare class CurrentFileSystem extends CurrentFileSystem_base {
+}
+/** @internal */
+export declare const FixtureMetadata: Schema.Struct<{
+    readonly uid: Schema.optionalKey<Schema.Natural>;
+    readonly gid: Schema.optionalKey<Schema.Natural>;
+    readonly mode: Schema.optionalKey<Schema.Natural>;
+    readonly atimeNs: Schema.optionalKey<Schema.BigInt>;
+    readonly mtimeNs: Schema.optionalKey<Schema.BigInt>;
+    readonly ctimeNs: Schema.optionalKey<Schema.BigInt>;
+    readonly birthtimeNs: Schema.optionalKey<Schema.BigInt>;
+}>;
+/** @internal */
+export declare const Fixture: Schema.Struct<{
+    readonly rootMetadata: Schema.optionalKey<Schema.Struct<{
+        readonly uid: Schema.optionalKey<Schema.Natural>;
+        readonly gid: Schema.optionalKey<Schema.Natural>;
+        readonly mode: Schema.optionalKey<Schema.Natural>;
+        readonly atimeNs: Schema.optionalKey<Schema.BigInt>;
+        readonly mtimeNs: Schema.optionalKey<Schema.BigInt>;
+        readonly ctimeNs: Schema.optionalKey<Schema.BigInt>;
+        readonly birthtimeNs: Schema.optionalKey<Schema.BigInt>;
+    }>>;
+    readonly entries: Schema.$Array<Schema.Union<readonly [Schema.Struct<{
+        readonly kind: Schema.Literal<"directory">;
+        readonly path: Schema.Union<readonly [Schema.String, Schema.declare<BytePath, BytePath>]>;
+        readonly metadata: Schema.optionalKey<Schema.Struct<{
+            readonly uid: Schema.optionalKey<Schema.Natural>;
+            readonly gid: Schema.optionalKey<Schema.Natural>;
+            readonly mode: Schema.optionalKey<Schema.Natural>;
+            readonly atimeNs: Schema.optionalKey<Schema.BigInt>;
+            readonly mtimeNs: Schema.optionalKey<Schema.BigInt>;
+            readonly ctimeNs: Schema.optionalKey<Schema.BigInt>;
+            readonly birthtimeNs: Schema.optionalKey<Schema.BigInt>;
+        }>>;
+    }>, Schema.Struct<{
+        readonly kind: Schema.Literal<"file">;
+        readonly path: Schema.Union<readonly [Schema.String, Schema.declare<BytePath, BytePath>]>;
+        readonly bytes: Schema.Uint8Array;
+        readonly metadata: Schema.optionalKey<Schema.Struct<{
+            readonly uid: Schema.optionalKey<Schema.Natural>;
+            readonly gid: Schema.optionalKey<Schema.Natural>;
+            readonly mode: Schema.optionalKey<Schema.Natural>;
+            readonly atimeNs: Schema.optionalKey<Schema.BigInt>;
+            readonly mtimeNs: Schema.optionalKey<Schema.BigInt>;
+            readonly ctimeNs: Schema.optionalKey<Schema.BigInt>;
+            readonly birthtimeNs: Schema.optionalKey<Schema.BigInt>;
+        }>>;
+    }>, Schema.Struct<{
+        readonly kind: Schema.Literal<"symlink">;
+        readonly path: Schema.Union<readonly [Schema.String, Schema.declare<BytePath, BytePath>]>;
+        readonly target: Schema.Union<readonly [Schema.String, Schema.declare<BytePath, BytePath>]>;
+        readonly metadata: Schema.optionalKey<Schema.Struct<{
+            readonly uid: Schema.optionalKey<Schema.Natural>;
+            readonly gid: Schema.optionalKey<Schema.Natural>;
+            readonly mode: Schema.optionalKey<Schema.Natural>;
+            readonly atimeNs: Schema.optionalKey<Schema.BigInt>;
+            readonly mtimeNs: Schema.optionalKey<Schema.BigInt>;
+            readonly ctimeNs: Schema.optionalKey<Schema.BigInt>;
+            readonly birthtimeNs: Schema.optionalKey<Schema.BigInt>;
+        }>>;
+    }>, Schema.Struct<{
+        readonly kind: Schema.Literal<"hardLink">;
+        readonly path: Schema.Union<readonly [Schema.String, Schema.declare<BytePath, BytePath>]>;
+        readonly target: Schema.Union<readonly [Schema.String, Schema.declare<BytePath, BytePath>]>;
+    }>]>>;
+}>;
+/** @internal */
+export type Fixture = typeof Fixture.Type;
+type VolumeSource = {
+    readonly _tag: "Empty";
+} | {
+    readonly _tag: "Snapshot";
+    readonly image: Image.Document;
+} | {
+    readonly _tag: "Overlay";
+    readonly base: Snapshot;
+    readonly image: Image.Document;
+};
+/** @internal */
+export declare const makeVolume: (source: VolumeSource, options?: {
+    readonly maxEntries?: number;
+    readonly maxBytes?: ByteSize.ByteSize;
+    readonly maxFileBytes?: ByteSize.ByteSize;
+    readonly maxPathBytes?: ByteSize.ByteSize;
+} | undefined) => Effect.Effect<{
+    _tag: "Volume";
+    volume: Volume;
+} | {
+    _tag: "Overlay";
+    volume: OverlayVolume;
+}, ConfigurationError | ImageError, never>;
+/** @internal */
+export declare const make: (options?: {
+    readonly maxEntries?: number;
+    readonly maxBytes?: ByteSize.ByteSize;
+    readonly maxFileBytes?: ByteSize.ByteSize;
+    readonly maxPathBytes?: ByteSize.ByteSize;
+} | undefined) => Effect.Effect<Volume, ConfigurationError, never>;
+/** @internal */
+export declare const fromSnapshot: (snapshot: Snapshot, options?: {
+    readonly maxEntries?: number;
+    readonly maxBytes?: ByteSize.ByteSize;
+    readonly maxFileBytes?: ByteSize.ByteSize;
+    readonly maxPathBytes?: ByteSize.ByteSize;
+} | undefined) => Effect.Effect<Volume, ConfigurationError | ImageError, never>;
+/** @internal */
+export declare const makeOverlay: (base: Snapshot, options?: {
+    readonly maxEntries?: number;
+    readonly maxBytes?: ByteSize.ByteSize;
+    readonly maxFileBytes?: ByteSize.ByteSize;
+    readonly maxPathBytes?: ByteSize.ByteSize;
+} | undefined) => Effect.Effect<OverlayVolume, ConfigurationError | ImageError, never>;
+//# sourceMappingURL=virtualFileSystem.d.ts.map

package/dist/internal/virtualFileSystem.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"virtualFileSystem.d.ts","sourceRoot":"","sources":["../../src/internal/virtualFileSystem.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,QAAQ,MAAM,iBAAiB,CAAA;AAE3C,OAAO,KAAK,OAAO,MAAM,gBAAgB,CAAA;AACzC,OAAO,KAAK,MAAM,MAAM,eAAe,CAAA;AAGvC,OAAO,KAAK,MAAM,MAAM,eAAe,CAAA;AAEvC,OAAO,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAA;AACzC,OAAO,EAAE,UAAU,EAAE,KAAK,QAAQ,EAAE,MAAM,gBAAgB,CAAA;AAC1D,OAAO,KAAK,EACV,MAAM,EAMN,aAAa,EAEb,eAAe,EACf,MAAM,EACP,MAAM,yBAAyB,CAAA;AAEhC,OAAO,KAAK,KAAK,MAAM,YAAY,CAAA;AACnC,OAAO,EAAE,kBAAkB,EAAE,MAAM,IAAI,YAAY,EAAE,OAAO,EAAE,MAAM,+BAA+B,CAAA;AAkBnG,gBAAgB;AAChB,eAAO,MAAM,QAAQ,eAAoC,CAAA;AAEzD,gBAAgB;AAChB,eAAO,MAAM,QAAQ,eAAoC,CAAA;AAEzD,gBAAgB;AAChB,eAAO,MAAM,YAAY,eAAwC,CAAA;AAEjE,gBAAgB;AAChB,eAAO,MAAM,iBAAiB,eAA6C,CAAA;AAE3E,gBAAgB;AAChB,eAAO,MAAM,iBAAiB,eAA6C,CAAA;AAE3E,gBAAgB;AAChB,OAAO,EAAE,kBAAkB,EAAE,YAAY,IAAI,MAAM,EAAE,OAAO,EAAE,CAAA;AAE9D,gBAAgB;AAChB,eAAO,MAAM,IAAI,gBAA2D,CAAA;AAE5E,gBAAgB;AAChB,eAAO,MAAM,QAAQ;;;;;EAKnB,CAAA;AAEF,gBAAgB;AAChB,MAAM,MAAM,QAAQ,GAAG,OAAO,QAAQ,CAAC,IAAI,CAAA;AAE3C,gBAAgB;AAChB,eAAO,MAAM,iBAAiB;;;;;;;;EAG5B,CAAA;AAEF,gBAAgB;AAChB,MAAM,MAAM,iBAAiB,GAAG,OAAO,iBAAiB,CAAC,IAAI,CAAA;AAE7D,gBAAgB;AAChB,eAAO,MAAM,aAAa;;;;;EAiBxB,CAAA;AAEF,gBAAgB;AAChB,MAAM,MAAM,aAAa,GAAG,OAAO,aAAa,CAAC,IAAI,CAAA;AAKrD,gBAAgB;AAChB,eAAO,MAAM,SAAS,eAGrB,CAAA;AAED,gBAAgB;AAChB,eAAO,MAAM,QAAQ;;;;;;;;;;;;EAYnB,CAAA;AAEF,gBAAgB;AAChB,MAAM,MAAM,QAAQ,GAAG,OAAO,QAAQ,CAAC,IAAI,CAAA;AAE3C,gBAAgB;AAChB,eAAO,MAAM,WAAW;;;EAGtB,CAAA;AAEF,gBAAgB;AAChB,MAAM,MAAM,WAAW,GAAG,OAAO,WAAW,CAAC,IAAI,CAAA;AAEjD,gBAAgB;AAChB,eAAO,MAAM,UAAU;;;;;;;IAIrB,CAAA;AAEF,gBAAgB;AAChB,eAAO,MAAM,KAAK;;;;;;;;;;;;;;;;;EAAkE,CAAA;AAEpF,gBAAgB;AAChB,MAAM,MAAM,KAAK,GAAG,OAAO,KAAK,CAAC,IAAI,CAAA;AAErC,gBAAgB;AAChB,eAAO,MAAM,QAAQ,uEAA+D,CAAA;AAEpF,gBAAgB;AAChB,MAAM,MAAM,QAAQ,GAAG,OAAO,QAAQ,CAAC,IAAI,CAAA;AAE3C,gBAAgB;AAChB,eAAO,MAAM,YAAY;;;;;;;EAOvB,CAAA;AAEF,gBAAgB;AAChB,MAAM,MAAM,WAAW,GAAG,OAAO,YAAY,CAAC,IAAI,GAAG,eAAe,CAAA;AAEpE,gBAAgB;AAChB,eAAO,MAAM,iBAAiB;;;;;;;;;EAI5B,CAAA;AAEF,gBAAgB;AAChB,MAAM,MAAM,gBAAgB,GAAG,OAAO,iBAAiB,CAAC,IAAI,GAAG,eAAe,CAAA;AAE9E,gBAAgB;AAChB,eAAO,MAAM,eAAe,4DAAoD,CAAA;AAEhF,gBAAgB;AAChB,MAAM,MAAM,eAAe,GAAG,OAAO,eAAe,CAAC,IAAI,CAAA;AAEzD,gBAAgB;AAChB,eAAO,MAAM,iBAAiB,6GAS5B,CAAA;AAEF,gBAAgB;AAChB,MAAM,MAAM,iBAAiB,GAAG,OAAO,iBAAiB,CAAC,IAAI,CAAA;AAI7D,gBAAgB;AAChB,eAAO,MAAM,aAAa;;;;;;;;;;;;;;;;;;;;IAgBxB,CAAA;AAEF,gBAAgB;AAChB,MAAM,MAAM,aAAa,GAAG,OAAO,aAAa,CAAC,IAAI,CAAA;AAErD,gBAAgB;AAChB,eAAO,MAAM,qBAAqB;;EAEhC,CAAA;AAEF,gBAAgB;AAChB,MAAM,MAAM,qBAAqB,GAAG,OAAO,qBAAqB,CAAC,IAAI,CAAA;;AAErE,gBAAgB;AAChB,qBAAa,iBACX,SAAQ,sBAAkF;CAC1F;AAEF,gBAAgB;AAChB,eAAO,MAAM,eAAe;;;;;;;;EAQ1B,CAAA;AAMF,gBAAgB;AAChB,eAAO,MAAM,OAAO;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAsBlB,CAAA;AAEF,gBAAgB;AAChB,MAAM,MAAM,OAAO,GAAG,OAAO,OAAO,CAAC,IAAI,CAAA;AA0EzC,KAAK,YAAY,GACb;IAAE,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAA;CAAE,GAC1B;IAAE,QAAQ,CAAC,IAAI,EAAE,UAAU,CAAC;IAAC,QAAQ,CAAC,KAAK,EAAE,KAAK,CAAC,QAAQ,CAAA;CAAE,GAC7D;IACA,QAAQ,CAAC,IAAI,EAAE,SAAS,CAAA;IACxB,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAA;IACvB,QAAQ,CAAC,KAAK,EAAE,KAAK,CAAC,QAAQ,CAAA;CAC/B,CAAA;AAIH,gBAAgB;AAChB,eAAO,MAAM,UAAU;;;;;;UA66CF,QAAQ;;;UAqBV,SAAS;;0CAE3B,CAAA;AAED,gBAAgB;AAChB,eAAO,MAAM,IAAI;;;;;kEAIf,CAAA;AAEF,gBAAgB;AAChB,eAAO,MAAM,YAAY;;;;;+EAOxB,CAAA;AAED,gBAAgB;AAChB,eAAO,MAAM,WAAW;;;;;sFAUvB,CAAA"}