powerlines 0.24.8 → 0.25.0

package/dist/lib/fs/vfs.d.ts

@@ -0,0 +1,247 @@
+import { FlatCache } from 'flat-cache';
+import { C as Context } from '../config-D-WwQL-4.js';
+import { V as VirtualFileSystemInterface, d as VirtualFileMetadata, W as WriteOptions, R as ResolveOptions } from '../fs-Dg-aTfiN.js';
+import '@storm-software/build-tools/types';
+import '@storm-software/config-tools/types';
+import '@storm-software/config/types';
+import '@stryke/types/base';
+import '@stryke/types/configuration';
+import '@stryke/types/file';
+import 'c12';
+import 'vite';
+import '@farmfe/core';
+import '@rspack/core';
+import '@storm-software/tsup/types';
+import '@storm-software/unbuild/types';
+import 'esbuild';
+import 'rolldown';
+import 'rollup';
+import 'webpack';
+import '@stryke/env/get-env-paths';
+import '@stryke/types/package-json';
+import 'jest-worker';
+import 'jiti';
+import 'magic-string';
+import 'semver';
+import 'ts-morph';
+import 'unplugin';
+import '@stryke/types/array';
+import '../tsconfig-Bz-CiFqD.js';
+import '@stryke/types/tsconfig';
+import 'typescript';
+import '@stryke/fs/resolve';
+
+/**
+ * Represents a virtual file system (VFS) that stores files and their associated metadata in virtual memory.
+ *
+ * @remarks
+ * This class provides methods to manage virtual files, check their existence, retrieve their content, and manipulate the virtual file system. It allows for efficient file management and retrieval without relying on the actual file system.
+ */
+declare class VirtualFileSystem implements VirtualFileSystemInterface {
+    #private;
+    /**
+     * Creates a virtual file system (VFS) that is backed up to a Cap'n Proto message buffer.
+     *
+     * @param context - The context of the virtual file system, typically containing options and logging functions.
+     * @returns A promise that resolves to a new virtual file system instance.
+     */
+    static create(context: Context): Promise<VirtualFileSystem>;
+    /**
+     * Synchronously creates a virtual file system (VFS) that is backed up to a Cap'n Proto message buffer.
+     *
+     * @param context - The context of the virtual file system, typically containing options and logging functions.
+     * @returns A new virtual file system instance.
+     */
+    static createSync(context: Context): VirtualFileSystem;
+    /**
+     * A map of file ids to their metadata.
+     */
+    get metadata(): Readonly<Record<string, VirtualFileMetadata>>;
+    /**
+     * A map of file paths to their module ids.
+     */
+    get ids(): Readonly<Record<string, string>>;
+    /**
+     * A map of module ids to their file paths.
+     */
+    get paths(): Readonly<Record<string, string>>;
+    /**
+     * Gets the resolver cache.
+     */
+    protected get resolverCache(): FlatCache;
+    /**
+     * Creates a new instance of the {@link VirtualFileSystem}.
+     *
+     * @param context - The context of the virtual file system, typically containing options and logging functions.
+     * @param fs - A buffer containing the serialized virtual file system data.
+     */
+    private constructor();
+    /**
+     * Asynchronously checks if a file exists in the virtual file system (VFS).
+     *
+     * @param path - The path to the file.
+     * @returns A promise that resolves to `true` if the file exists, otherwise `false`.
+     */
+    exists(path: string): Promise<boolean>;
+    /**
+     * Synchronously checks if a file exists in the virtual file system (VFS).
+     *
+     * @param path - The path to the file.
+     * @returns `true` if the file exists, otherwise `false`.
+     */
+    existsSync(path: string): boolean;
+    /**
+     * Checks if a file is virtual in the virtual file system (VFS).
+     *
+     * @param path - The path to the file.
+     * @returns `true` if the file is virtual, otherwise `false`.
+     */
+    isVirtual(path: string): boolean;
+    /**
+     * Lists files in a given path.
+     *
+     * @param path - The path to list files from.
+     * @returns An array of file names in the specified path.
+     */
+    listSync(path?: string): string[];
+    /**
+     * Lists files in a given path.
+     *
+     * @param path - The path to list files from.
+     * @returns An array of file names in the specified path.
+     */
+    list(path?: string): Promise<string[]>;
+    /**
+     * Removes a file in the virtual file system (VFS).
+     *
+     * @param path - The path to create the directory at.
+     */
+    remove(path: string): Promise<void>;
+    /**
+     * Removes a file in the virtual file system (VFS).
+     *
+     * @param path - The path to create the directory at.
+     */
+    removeSync(path: string): void;
+    /**
+     * Glob files in the virtual file system (VFS) based on the provided pattern(s).
+     *
+     * @param patterns - A pattern (or multiple patterns) to use to determine the file paths to return
+     * @returns An array of file paths matching the provided pattern(s)
+     */
+    glob(patterns: string | string[]): Promise<string[]>;
+    /**
+     * Synchronously glob files in the virtual file system (VFS) based on the provided pattern(s).
+     *
+     * @param patterns - A pattern (or multiple patterns) to use to determine the file paths to return
+     * @returns An array of file paths matching the provided pattern(s)
+     */
+    globSync(patterns: string | string[]): string[];
+    /**
+     * Copies a file from one path to another in the virtual file system (VFS).
+     *
+     * @param srcPath - The source path to copy
+     * @param destPath - The destination path to copy to
+     */
+    copy(srcPath: string, destPath: string): Promise<void>;
+    /**
+     * Synchronously copies a file from one path to another in the virtual file system (VFS).
+     *
+     * @param srcPath - The source path to copy
+     * @param destPath - The destination path to copy to
+     */
+    copySync(srcPath: string, destPath: string): void;
+    /**
+     * Moves a file (or files) from one path to another in the virtual file system (VFS).
+     *
+     * @param srcPath - The source path to move
+     * @param destPath - The destination path to move to
+     */
+    move(srcPath: string, destPath: string): Promise<void>;
+    /**
+     * Synchronously moves a file (or files) from one path to another in the virtual file system (VFS).
+     *
+     * @param srcPath - The source path to move
+     * @param destPath - The destination path to move to
+     */
+    moveSync(srcPath: string, destPath: string): void;
+    /**
+     * Asynchronously reads a file from the virtual file system (VFS).
+     *
+     * @param path - The path or ID of the file to read.
+     * @returns A promise that resolves to the contents of the file as a string, or undefined if the file does not exist.
+     */
+    read(path: string): Promise<string | undefined>;
+    /**
+     * Synchronously reads a file from the virtual file system (VFS).
+     *
+     * @param path - The path or ID of the file to read.
+     * @returns The contents of the file as a string, or undefined if the file does not exist.
+     */
+    readSync(path: string): string | undefined;
+    /**
+     * Writes a file to the virtual file system (VFS).
+     *
+     * @param path - The path to the file.
+     * @param data - The contents of the file.
+     * @param options - Optional parameters for writing the file.
+     * @returns A promise that resolves when the file is written.
+     */
+    write(path: string, data?: string, options?: WriteOptions): Promise<void>;
+    /**
+     * Synchronously writes a file to the virtual file system (VFS).
+     *
+     * @param path - The file to write.
+     * @param data - The contents of the file.
+     * @param options - Optional parameters for writing the file.
+     */
+    writeSync(path: string, data?: string, options?: WriteOptions): void;
+    /**
+     * Retrieves the metadata of a file in the virtual file system (VFS).
+     *
+     * @param pathOrId - The path or ID of the file to retrieve metadata for.
+     * @returns The metadata of the file, or undefined if the file does not exist.
+     */
+    getMetadata(pathOrId: string): VirtualFileMetadata | undefined;
+    /**
+     * A helper function to resolve modules in the virtual file system (VFS).
+     *
+     * @remarks
+     * This function can be used to resolve modules relative to the project root directory.
+     *
+     * @example
+     * ```ts
+     * const resolved = await context.resolvePath("some-module", "/path/to/importer");
+     * ```
+     *
+     * @param id - The module to resolve.
+     * @param importer - An optional path to the importer module.
+     * @param options - Additional resolution options.
+     * @returns A promise that resolves to the resolved module path.
+     */
+    resolve(id: string, importer?: string, options?: ResolveOptions): Promise<string | undefined>;
+    /**
+     * A synchronous helper function to resolve modules using the Jiti resolver
+     *
+     * @remarks
+     * This function can be used to resolve modules relative to the project root directory.
+     *
+     * @example
+     * ```ts
+     * const resolvedPath = context.resolveSync("some-module", "/path/to/importer");
+     * ```
+     *
+     * @param id - The module to resolve.
+     * @param importer - An optional path to the importer module.
+     * @param options - Additional resolution options.
+     * @returns The resolved module path.
+     */
+    resolveSync(id: string, importer?: string, options?: ResolveOptions): string | undefined;
+    /**
+     * Disposes of the virtual file system (VFS) by saving its state to disk.
+     */
+    dispose(): Promise<void>;
+    [Symbol.asyncDispose](): Promise<void>;
+}
+
+export { VirtualFileSystem };

package/dist/lib/fs/vfs.js

@@ -0,0 +1,7 @@
+export { VirtualFileSystem } from '../chunk-OBA5U4Y2.js';
+import '../chunk-L56XA427.js';
+import '../chunk-ONETLSPO.js';
+import '../chunk-VHCBD2IS.js';
+import '../chunk-KFDNKOXM.js';
+import '../chunk-ENRLU4UR.js';
+import '../chunk-SHUYVCID.js';

package/dist/lib/fs-Dg-aTfiN.d.cts

@@ -0,0 +1,378 @@
+import { ResolveOptions as ResolveOptions$1 } from '@stryke/fs/resolve';
+import { MaybePromise } from '@stryke/types/base';
+
+declare enum StoragePreset {
+    VIRTUAL = "virtual",
+    FS = "fs"
+}
+/**
+ * Interface defining the methods and properties for a storage adapter.
+ */
+interface StorageAdapter {
+    /**
+     * A name identifying the storage adapter type.
+     */
+    name: string;
+    /**
+     * Checks if a key exists in the storage.
+     *
+     * @param key - The key to check for existence.
+     * @returns A promise that resolves to `true` if the key exists, otherwise `false`.
+     */
+    exists: (key: string) => Promise<boolean>;
+    /**
+     * Synchronously checks if a key exists in the storage.
+     *
+     * @param key - The key to check for existence.
+     * @returns Returns `true` if the key exists, otherwise `false`.
+     */
+    existsSync: (key: string) => boolean;
+    /**
+     * Read a value associated with a key from the storage.
+     *
+     * @param key - The key to read the value for.
+     * @returns A promise that resolves to the value if found, otherwise `null`.
+     */
+    get: (key: string) => Promise<string | null>;
+    /**
+     * Synchronously reads the value associated with a key from the storage.
+     *
+     * @param key - The key to read the value for.
+     * @returns The value if found, otherwise `null`.
+     */
+    getSync: (key: string) => string | null;
+    /**
+     * Writes a value to the storage for the given key.
+     *
+     * @param key - The key to associate the value with.
+     * @param value - The value to store.
+     */
+    set: (key: string, value: string) => Promise<void>;
+    /**
+     * Synchronously writes a value to the storage for the given key.
+     *
+     * @param key - The key to associate the value with.
+     * @param value - The value to store.
+     */
+    setSync: (key: string, value: string) => void;
+    /**
+     * Removes a value from the storage.
+     *
+     * @param key - The key whose value should be removed.
+     */
+    remove: (key: string) => Promise<void>;
+    /**
+     * Synchronously removes a value from the storage.
+     *
+     * @param key - The key whose value should be removed.
+     */
+    removeSync: (key: string) => void;
+    /**
+     * Remove all entries from the storage that match the provided base path.
+     *
+     * @param base - The base path or prefix to clear entries from.
+     */
+    clear: (base?: string) => Promise<void>;
+    /**
+     * Synchronously remove all entries from the storage that match the provided base path.
+     *
+     * @param base - The base path or prefix to clear entries from.
+     */
+    clearSync: (base?: string) => void;
+    /**
+     * Lists all keys under the provided base path.
+     *
+     * @param base - The base path or prefix to list keys from.
+     * @returns A promise resolving to the list of keys.
+     */
+    list: (base?: string) => Promise<string[]>;
+    /**
+     * Synchronously lists all keys under the provided base path.
+     *
+     * @param base - The base path or prefix to list keys from.
+     * @returns The list of keys.
+     */
+    listSync: (base?: string) => string[];
+    /**
+     * Releases any resources held by the storage adapter.
+     */
+    dispose: () => MaybePromise<void>;
+}
+/**
+ * A mapping of file paths to storage adapter names and their corresponding {@link StorageAdapter} instances.
+ */
+type StoragePort = Record<string, StorageAdapter>;
+interface VirtualFileMetadata {
+    /**
+     * The identifier for the file data.
+     */
+    id: string;
+    /**
+     * The timestamp of the virtual file.
+     */
+    timestamp: number;
+    /**
+     * The type of the file.
+     *
+     * @remarks
+     * This string represents the purpose/function of the file in the virtual file system. A potential list of variants includes:
+     * - `builtin`: Indicates that the file is a built-in module provided by the system.
+     * - `entry`: Indicates that the file is an entry point for execution.
+     * - `normal`: Indicates that the file is a standard file without any special role.
+     */
+    type: string;
+    /**
+     * Additional metadata associated with the file.
+     */
+    properties: Record<string, string>;
+}
+interface VirtualFileData {
+    /**
+     * The identifier for the file data.
+     */
+    id?: string;
+    /**
+     * The contents of the virtual file.
+     */
+    code: string;
+    /**
+     * The type of the file.
+     *
+     * @remarks
+     * This string represents the purpose/function of the file in the virtual file system. A potential list of variants includes:
+     * - `builtin`: Indicates that the file is a built-in module provided by the system.
+     * - `entry`: Indicates that the file is an entry point for execution.
+     * - `normal`: Indicates that the file is a standard file without any special role.
+     */
+    type?: string;
+    /**
+     * Additional metadata associated with the file.
+     */
+    properties?: Record<string, string>;
+}
+interface VirtualFile extends Required<VirtualFileData>, VirtualFileMetadata {
+    /**
+     * An additional name for the file.
+     */
+    path: string;
+    /**
+     * The timestamp of the virtual file.
+     */
+    timestamp: number;
+}
+interface WriteOptions {
+    /**
+     * Should the file skip formatting before being written?
+     *
+     * @defaultValue false
+     */
+    skipFormat?: boolean;
+    /**
+     * Additional metadata for the file.
+     */
+    meta?: VirtualFileMetadata;
+}
+interface ResolveOptions extends ResolveOptions$1 {
+    /**
+     * If true, the module is being resolved as an entry point.
+     */
+    isEntry?: boolean;
+    /**
+     * If true, the resolver will skip using the cache when resolving modules.
+     */
+    skipCache?: boolean;
+    /**
+     * An array of external modules or patterns to exclude from resolution.
+     */
+    external?: (string | RegExp)[];
+    /**
+     * An array of modules or patterns to include in the resolution, even if they are marked as external.
+     */
+    noExternal?: (string | RegExp)[];
+    /**
+     * An array of patterns to match when resolving modules.
+     */
+    skipNodeModulesBundle?: boolean;
+}
+interface VirtualFileSystemInterface {
+    /**
+     * The underlying file metadata.
+     */
+    metadata: Readonly<Record<string, VirtualFileMetadata>>;
+    /**
+     * A map of file paths to their module ids.
+     */
+    ids: Readonly<Record<string, string>>;
+    /**
+     * A map of module ids to their file paths.
+     */
+    paths: Readonly<Record<string, string>>;
+    /**
+     * Checks if a file exists in the virtual file system (VFS).
+     *
+     * @param path - The path or id of the file.
+     * @returns `true` if the file exists, otherwise `false`.
+     */
+    exists: (path: string) => Promise<boolean>;
+    /**
+     * Synchronously Checks if a file exists in the virtual file system (VFS).
+     *
+     * @param path - The path or id of the file.
+     * @returns `true` if the file exists, otherwise `false`.
+     */
+    existsSync: (path: string) => boolean;
+    /**
+     * Checks if a file is virtual in the virtual file system (VFS).
+     *
+     * @param path - The path or id of the file.
+     * @returns `true` if the file is virtual, otherwise `false`.
+     */
+    isVirtual: (path: string) => boolean;
+    /**
+     * Gets the metadata of a file in the virtual file system (VFS).
+     *
+     * @param path - The path or id of the file.
+     * @returns The metadata of the file if it exists, otherwise undefined.
+     */
+    getMetadata: (path: string) => VirtualFileMetadata | undefined;
+    /**
+     * Lists files in a given path.
+     *
+     * @param path - The path to list files from.
+     * @returns An array of file names in the specified path.
+     */
+    listSync: (path: string) => string[];
+    /**
+     * Lists files in a given path.
+     *
+     * @param path - The path to list files from.
+     * @returns An array of file names in the specified path.
+     */
+    list: (path: string) => Promise<string[]>;
+    /**
+     * Removes a file or symbolic link in the virtual file system (VFS).
+     *
+     * @param path - The path to the file to remove.
+     * @returns A promise that resolves when the file is removed.
+     */
+    removeSync: (path: string) => void;
+    /**
+     * Asynchronously removes a file or symbolic link in the virtual file system (VFS).
+     *
+     * @param path - The path to the file to remove.
+     * @returns A promise that resolves when the file is removed.
+     */
+    remove: (path: string) => Promise<void>;
+    /**
+     * Reads a file from the virtual file system (VFS).
+     *
+     * @param path - The path or id of the file.
+     * @returns The contents of the file if it exists, otherwise undefined.
+     */
+    read: (path: string) => Promise<string | undefined>;
+    /**
+     * Reads a file from the virtual file system (VFS).
+     *
+     * @param path - The path or id of the file.
+     */
+    readSync: (path: string) => string | undefined;
+    /**
+     * Writes a file to the virtual file system (VFS).
+     *
+     * @param path - The path to the file.
+     * @param data - The contents of the file.
+     * @param options - Options for writing the file.
+     * @returns A promise that resolves when the file is written.
+     */
+    write: (path: string, data: string, options?: WriteOptions) => Promise<void>;
+    /**
+     * Writes a file to the virtual file system (VFS).
+     *
+     * @param path - The path to the file.
+     * @param data - The contents of the file.
+     * @param options - Options for writing the file.
+     */
+    writeSync: (path: string, data: string, options?: WriteOptions) => void;
+    /**
+     * Moves a file from one path to another in the virtual file system (VFS).
+     *
+     * @param srcPath - The source path to move
+     * @param destPath - The destination path to move to
+     */
+    move: (srcPath: string, destPath: string) => Promise<void>;
+    /**
+     * Synchronously moves a file from one path to another in the virtual file system (VFS).
+     *
+     * @param srcPath - The source path to move
+     * @param destPath - The destination path to move to
+     */
+    moveSync: (srcPath: string, destPath: string) => void;
+    /**
+     * Copies a file from one path to another in the virtual file system (VFS).
+     *
+     * @param srcPath - The source path to copy
+     * @param destPath - The destination path to copy to
+     */
+    copy: (srcPath: string, destPath: string) => Promise<void>;
+    /**
+     * Synchronously copies a file from one path to another in the virtual file system (VFS).
+     *
+     * @param srcPath - The source path to copy
+     * @param destPath - The destination path to copy to
+     */
+    copySync: (srcPath: string, destPath: string) => void;
+    /**
+     * Glob files in the virtual file system (VFS) based on the provided pattern(s).
+     *
+     * @param pattern - A pattern (or multiple patterns) to use to determine the file paths to return
+     * @returns An array of file paths matching the provided pattern(s)
+     */
+    glob: (pattern: string | string[]) => Promise<string[]>;
+    /**
+     * Synchronously glob files in the virtual file system (VFS) based on the provided pattern(s).
+     *
+     * @param pattern - A pattern (or multiple patterns) to use to determine the file paths to return
+     * @returns An array of file paths matching the provided pattern(s)
+     */
+    globSync: (pattern: string | string[]) => string[];
+    /**
+     * A helper function to resolve modules using the Jiti resolver
+     *
+     * @remarks
+     * This function can be used to resolve modules relative to the project root directory.
+     *
+     * @example
+     * ```ts
+     * const resolvedPath = await context.resolve("some-module", "/path/to/importer");
+     * ```
+     *
+     * @param id - The module to resolve.
+     * @param importer - An optional path to the importer module.
+     * @param options - Additional resolution options.
+     * @returns A promise that resolves to the resolved module path.
+     */
+    resolve: (id: string, importer?: string, options?: ResolveOptions) => Promise<string | undefined>;
+    /**
+     * A synchronous helper function to resolve modules using the Jiti resolver
+     *
+     * @remarks
+     * This function can be used to resolve modules relative to the project root directory.
+     *
+     * @example
+     * ```ts
+     * const resolvedPath = context.resolveSync("some-module", "/path/to/importer");
+     * ```
+     *
+     * @param id - The module to resolve.
+     * @param importer - An optional path to the importer module.
+     * @param options - Additional resolution options.
+     * @returns The resolved module path.
+     */
+    resolveSync: (id: string, importer?: string, options?: ResolveOptions) => string | undefined;
+    /**
+     * Disposes of the virtual file system (VFS), writes any virtual file changes to disk, and releases any associated resources.
+     */
+    dispose: () => Promise<void>;
+}
+
+export { type ResolveOptions as R, type StorageAdapter as S, type VirtualFileSystemInterface as V, type WriteOptions as W, type VirtualFile as a, type StoragePort as b, StoragePreset as c, type VirtualFileMetadata as d };