@powerlines/plugin-env 0.13.5 → 0.13.6

package/dist/vfs-Bl84Hw2V.d.ts

@@ -0,0 +1,393 @@
+import { PrimitiveJsonValue } from '@stryke/json/types';
+import { Volume } from 'memfs';
+import { PathLike, StatSyncOptions, Stats, RmDirOptions, RmOptions, Mode, MakeDirectoryOptions as MakeDirectoryOptions$1, PathOrFileDescriptor, WriteFileOptions as WriteFileOptions$1 } from 'node:fs';
+import { IUnionFs } from 'unionfs';
+
+declare const __VFS_INIT__ = "__VFS_INIT__";
+declare const __VFS_REVERT__ = "__VFS_REVERT__";
+declare const __VFS_CACHE__ = "__VFS_CACHE__";
+declare const __VFS_VIRTUAL__ = "__VFS_VIRTUAL__";
+declare const __VFS_UNIFIED__ = "__VFS_UNIFIED__";
+type OutputModeType = "fs" | "virtual";
+interface VirtualFile {
+    /**
+     * The unique identifier for the virtual file.
+     *
+     * @remarks
+     * If no specific id is provided, it defaults to the file's {@link path}.
+     */
+    id: string;
+    /**
+     * Additional metadata associated with the virtual file.
+     */
+    details: Record<string, PrimitiveJsonValue>;
+    /**
+     * The variant 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.
+     */
+    variant: string;
+    /**
+     * The output mode of the file.
+     *
+     * @remarks
+     * This indicates whether the file is intended to be written to the actual file system (`fs`) or kept in the virtual file system (`virtual`).
+     */
+    mode: OutputModeType;
+    /**
+     * A virtual (or actual) path to the file in the file system.
+     */
+    path: string;
+    /**
+     * The contents of the file.
+     */
+    code: string | NodeJS.ArrayBufferView;
+}
+type VirtualFileSystemMetadata = Pick<VirtualFile, "id" | "details" | "variant" | "mode">;
+interface ResolveFSOptions {
+    mode?: OutputModeType;
+}
+type MakeDirectoryOptions = (Mode | MakeDirectoryOptions$1) & ResolveFSOptions;
+interface PowerlinesWriteFileOptions extends ResolveFSOptions {
+    skipFormat?: boolean;
+}
+type NodeWriteFileOptions = WriteFileOptions$1;
+type WriteFileOptions = NodeWriteFileOptions | PowerlinesWriteFileOptions;
+type PowerLinesWriteFileData = Partial<Omit<VirtualFile, "path" | "mode" | "code">> & Pick<VirtualFile, "code">;
+type WriteFileData = string | NodeJS.ArrayBufferView | PowerLinesWriteFileData;
+interface ResolvePathOptions extends ResolveFSOptions {
+    /**
+     * Should the resolved path include the file extension?
+     *
+     * @defaultValue true
+     */
+    withExtension?: boolean;
+    /**
+     * The paths to search for the file.
+     */
+    paths?: string[];
+    /**
+     * The type of the path to resolve.
+     */
+    type?: "file" | "directory";
+}
+interface VirtualFileSystemInterface {
+    [__VFS_INIT__]: () => void;
+    [__VFS_REVERT__]: () => void;
+    /**
+     * The underlying file metadata.
+     */
+    meta: Record<string, VirtualFileSystemMetadata | undefined>;
+    /**
+     * A map of module ids to their file paths.
+     */
+    ids: Record<string, string>;
+    /**
+     * Check if a path or id corresponds to a virtual file **(does not actually exists on disk)**.
+     *
+     * @param pathOrId - The path or id to check.
+     * @param options - Optional parameters for resolving the path.
+     * @returns Whether the path or id corresponds to a virtual file **(does not actually exists on disk)**.
+     */
+    isVirtual: (pathOrId: string, options?: ResolvePathOptions) => boolean;
+    /**
+     * Check if a path or id corresponds to a file written to the file system **(actually exists on disk)**.
+     *
+     * @param pathOrId - The path or id to check.
+     * @param options - Optional parameters for resolving the path.
+     * @returns Whether the path or id corresponds to a file written to the file system **(actually exists on disk)**.
+     */
+    isFs: (pathOrId: string, options?: ResolvePathOptions) => boolean;
+    /**
+     * Checks if a file exists in the virtual file system (VFS).
+     *
+     * @param path - The path of the file to check.
+     * @returns `true` if the file exists, otherwise `false`.
+     */
+    isFile: (path: string) => boolean;
+    /**
+     * Checks if a directory exists in the virtual file system (VFS).
+     *
+     * @param path - The path of the directory to check.
+     * @returns `true` if the directory exists, otherwise `false`.
+     */
+    isDirectory: (path: string) => boolean;
+    /**
+     * Check if a path exists within one of the directories specified in the tsconfig.json's `path` field.
+     *
+     * @see https://www.typescriptlang.org/tsconfig#paths
+     *
+     * @param pathOrId - The path or id to check.
+     * @returns Whether the path or id corresponds to a virtual file.
+     */
+    isTsconfigPath: (pathOrId: string) => boolean;
+    /**
+     * Checks if a file exists in the virtual file system (VFS).
+     *
+     * @param pathOrId - The path or id of the file.
+     * @returns `true` if the file exists, otherwise `false`.
+     */
+    existsSync: (pathOrId: string) => boolean;
+    /**
+     * Gets the metadata of a file in the virtual file system (VFS).
+     *
+     * @param pathOrId - The path or id of the file.
+     * @returns The metadata of the file if it exists, otherwise undefined.
+     */
+    getMetadata: (pathOrId: PathLike) => VirtualFileSystemMetadata | undefined;
+    /**
+     * Gets the stats of a file in the virtual file system (VFS).
+     *
+     * @param pathOrId - The path or id of the file.
+     * @param options - Optional parameters for getting the stats.
+     * @returns The stats of the file if it exists, otherwise undefined.
+     */
+    lstat: (pathOrId: string, options?: StatSyncOptions & {
+        bigint?: false | undefined;
+        throwIfNoEntry: false;
+    }) => Promise<Stats>;
+    /**
+     * Gets the stats of a file in the virtual file system (VFS).
+     *
+     * @param pathOrId - The path or id of the file.
+     * @param options - Optional parameters for getting the stats.
+     * @returns The stats of the file if it exists, otherwise undefined.
+     */
+    lstatSync: (pathOrId: string, options?: StatSyncOptions & {
+        bigint?: false | undefined;
+        throwIfNoEntry: false;
+    }) => Stats | undefined;
+    /**
+     * Gets the stats of a file in the virtual file system (VFS).
+     *
+     * @param pathOrId - The path or id of the file.
+     * @returns The stats of the file if it exists, otherwise false.
+     */
+    stat: (pathOrId: string, options?: StatSyncOptions & {
+        bigint?: false | undefined;
+        throwIfNoEntry: false;
+    }) => Promise<Stats>;
+    /**
+     * Gets the stats of a file in the virtual file system (VFS).
+     *
+     * @param pathOrId - The path or id of the file.
+     * @returns The stats of the file if it exists, otherwise false.
+     */
+    statSync: (pathOrId: string, options?: StatSyncOptions & {
+        bigint?: false | undefined;
+        throwIfNoEntry: false;
+    }) => Stats | undefined;
+    /**
+     * Lists files in a given path.
+     *
+     * @param path - The path to list files from.
+     * @param options - Options for listing files, such as encoding and recursion.
+     * @returns An array of file names in the specified path.
+     */
+    readdirSync: (path: string, options?: {
+        encoding: BufferEncoding | null;
+        withFileTypes?: false | undefined;
+        recursive?: boolean | undefined;
+    } | BufferEncoding) => string[];
+    /**
+     * Lists files in a given path.
+     *
+     * @param path - The path to list files from.
+     * @param options - Options for listing files, such as encoding and recursion.
+     * @returns An array of file names in the specified path.
+     */
+    readdir: (path: string, options?: {
+        encoding: BufferEncoding | null;
+        withFileTypes?: false | undefined;
+        recursive?: boolean | undefined;
+    } | BufferEncoding) => 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.
+     */
+    unlinkSync: (path: PathLike, options?: ResolveFSOptions) => 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.
+     */
+    unlink: (path: string, options?: ResolveFSOptions) => Promise<void>;
+    /**
+     * Removes a directory in the virtual file system (VFS).
+     *
+     * @param path - The path to create the directory at.
+     * @param options - Options for creating the directory.
+     */
+    rmdirSync: (path: PathLike, options?: RmDirOptions & ResolveFSOptions) => any;
+    /**
+     * Removes a directory in the virtual file system (VFS).
+     *
+     * @param path - The path to create the directory at.
+     * @param options - Options for creating the directory.
+     * @returns A promise that resolves to the path of the created directory, or undefined if the directory could not be created.
+     */
+    rmdir: (path: PathLike, options?: RmDirOptions & ResolveFSOptions) => Promise<void>;
+    /**
+     * Removes a file or directory in the virtual file system (VFS).
+     *
+     * @param path - The path to the file or directory to remove.
+     * @param options - Options for removing the file or directory.
+     * @returns A promise that resolves when the file or directory is removed.
+     */
+    rm: (path: PathLike, options?: RmOptions & ResolveFSOptions) => Promise<void>;
+    /**
+     * Synchronously removes a file or directory in the virtual file system (VFS).
+     *
+     * @param path - The path to the file or directory to remove.
+     * @param options - Options for removing the file or directory.
+     */
+    rmSync: (path: PathLike, options?: RmOptions & ResolveFSOptions) => void;
+    /**
+     * Creates a directory in the virtual file system (VFS).
+     *
+     * @param path - The path to create the directory at.
+     * @param options - Options for creating the directory.
+     * @returns A promise that resolves to the path of the created directory, or undefined if the directory could not be created.
+     */
+    mkdirSync: (path: PathLike, options?: MakeDirectoryOptions) => string | undefined;
+    /**
+     * Creates a directory in the virtual file system (VFS).
+     *
+     * @param path - The path to create the directory at.
+     * @param options - Options for creating the directory.
+     * @returns A promise that resolves to the path of the created directory, or undefined if the directory could not be created.
+     */
+    mkdir: (path: PathLike, options?: MakeDirectoryOptions) => Promise<string | undefined>;
+    /**
+     * Reads a file from the virtual file system (VFS).
+     *
+     * @param pathOrId - The path or id of the file.
+     * @returns The contents of the file if it exists, otherwise undefined.
+     */
+    readFile: (pathOrId: string) => Promise<string | undefined>;
+    /**
+     * Reads a file from the virtual file system (VFS).
+     *
+     * @param pathOrId - The path or id of the file.
+     */
+    readFileSync: (pathOrId: 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.
+     */
+    writeFile: (path: PathOrFileDescriptor, data?: WriteFileData, options?: WriteFileOptions) => 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 - Optional parameters for writing the file.
+     */
+    writeFileSync: (path: PathOrFileDescriptor, data?: WriteFileData, options?: WriteFileOptions) => 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[];
+    /**
+     * Resolves a path or id to a file path in the virtual file system.
+     *
+     * @param pathOrId - The path or id of the file to resolve.
+     * @param options - Optional parameters for resolving the path.
+     * @returns The resolved path of the file if it exists, otherwise false.
+     */
+    resolve: (pathOrId: string, options?: ResolvePathOptions) => string | false;
+    /**
+     * Resolves a path based on TypeScript's `tsconfig.json` paths.
+     *
+     * @see https://www.typescriptlang.org/tsconfig#paths
+     *
+     * @param path - The path to check.
+     * @returns The resolved file path if it exists, otherwise undefined.
+     */
+    resolveTsconfigPath: (path: string) => string | false;
+    /**
+     * Resolves a package name based on TypeScript's `tsconfig.json` paths.
+     *
+     * @see https://www.typescriptlang.org/tsconfig#paths
+     *
+     * @param path - The path to check.
+     * @returns The resolved package name if it exists, otherwise undefined.
+     */
+    resolveTsconfigPathPackage: (path: string) => string | false;
+    /**
+     * Resolves a path or id to a file path in the virtual file system.
+     *
+     * @param pathOrId - The path or id of the file to resolve.
+     * @returns The resolved path of the file if it exists, otherwise false.
+     */
+    realpathSync: (pathOrId: string) => string;
+    /**
+     * Retrieves a partial metadata mapping of all files in the virtual file system (VFS).
+     *
+     * @returns A record mapping file paths to their partial metadata.
+     */
+    getPartialMeta: () => Record<string, Partial<VirtualFileSystemMetadata>>;
+    /**
+     * A map of cached file paths to their underlying file content.
+     */
+    [__VFS_CACHE__]: Map<string, string>;
+    /**
+     * A reference to the underlying virtual file system.
+     */
+    [__VFS_VIRTUAL__]: Volume;
+    /**
+     * A reference to the underlying unified file system.
+     */
+    [__VFS_UNIFIED__]: IUnionFs;
+}
+
+export type { OutputModeType as O, PowerlinesWriteFileOptions as P, VirtualFileSystemInterface as V, VirtualFile as a };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@powerlines/plugin-env",
-  "version": "0.13.5",
+  "version": "0.13.6",
   "type": "module",
   "description": "A package containing a Powerlines plugin for injecting static .env configuration values to the code so that they're accessible at runtime.",
   "repository": {
@@ -38,143 +38,137 @@
   },
   "license": "Apache-2.0",
   "private": false,
-  "typings": "dist/index.d.mts",
-  "main": "dist/index.js",
-  "module": "dist/index.mjs",
+  "typings": "dist/index.d.ts",
+  "main": "dist/index.cjs",
+  "module": "dist/index.js",
   "exports": {
     "./package.json": "./package.json",
     ".": {
-      "import": {
-        "types": "./dist/index.d.mts",
-        "default": "./dist/index.mjs"
+      "import": { "types": "./dist/index.d.ts", "default": "./dist/index.js" },
+      "require": {
+        "types": "./dist/index.d.cts",
+        "default": "./dist/index.cjs"
       },
-      "require": { "types": "./dist/index.d.ts", "default": "./dist/index.js" },
-      "default": {
-        "types": "./dist/index.d.mts",
-        "default": "./dist/index.mjs"
-      }
+      "default": { "types": "./dist/index.d.ts", "default": "./dist/index.js" }
     },
     "./index": {
-      "import": {
-        "types": "./dist/index.d.mts",
-        "default": "./dist/index.mjs"
+      "import": { "types": "./dist/index.d.ts", "default": "./dist/index.js" },
+      "require": {
+        "types": "./dist/index.d.cts",
+        "default": "./dist/index.cjs"
       },
-      "require": { "types": "./dist/index.d.ts", "default": "./dist/index.js" },
-      "default": {
-        "types": "./dist/index.d.mts",
-        "default": "./dist/index.mjs"
-      }
+      "default": { "types": "./dist/index.d.ts", "default": "./dist/index.js" }
     },
     "./types": {
       "import": {
-        "types": "./dist/types/index.d.mts",
-        "default": "./dist/types/index.mjs"
-      },
-      "require": {
         "types": "./dist/types/index.d.ts",
         "default": "./dist/types/index.js"
       },
+      "require": {
+        "types": "./dist/types/index.d.cts",
+        "default": "./dist/types/index.cjs"
+      },
       "default": {
-        "types": "./dist/types/index.d.mts",
-        "default": "./dist/types/index.mjs"
+        "types": "./dist/types/index.d.ts",
+        "default": "./dist/types/index.js"
       }
     },
     "./types/*": {
       "import": {
-        "types": "./dist/types/*.d.mts",
-        "default": "./dist/types/*.mjs"
-      },
-      "require": {
         "types": "./dist/types/*.d.ts",
         "default": "./dist/types/*.js"
       },
+      "require": {
+        "types": "./dist/types/*.d.cts",
+        "default": "./dist/types/*.cjs"
+      },
       "default": {
-        "types": "./dist/types/*.d.mts",
-        "default": "./dist/types/*.mjs"
+        "types": "./dist/types/*.d.ts",
+        "default": "./dist/types/*.js"
       }
     },
     "./helpers": {
       "import": {
-        "types": "./dist/helpers/index.d.mts",
-        "default": "./dist/helpers/index.mjs"
-      },
-      "require": {
         "types": "./dist/helpers/index.d.ts",
         "default": "./dist/helpers/index.js"
       },
+      "require": {
+        "types": "./dist/helpers/index.d.cts",
+        "default": "./dist/helpers/index.cjs"
+      },
       "default": {
-        "types": "./dist/helpers/index.d.mts",
-        "default": "./dist/helpers/index.mjs"
+        "types": "./dist/helpers/index.d.ts",
+        "default": "./dist/helpers/index.js"
       }
     },
     "./helpers/*": {
       "import": {
-        "types": "./dist/helpers/*.d.mts",
-        "default": "./dist/helpers/*.mjs"
-      },
-      "require": {
         "types": "./dist/helpers/*.d.ts",
         "default": "./dist/helpers/*.js"
       },
+      "require": {
+        "types": "./dist/helpers/*.d.cts",
+        "default": "./dist/helpers/*.cjs"
+      },
       "default": {
-        "types": "./dist/helpers/*.d.mts",
-        "default": "./dist/helpers/*.mjs"
+        "types": "./dist/helpers/*.d.ts",
+        "default": "./dist/helpers/*.js"
       }
     },
     "./components": {
       "import": {
-        "types": "./dist/components/index.d.mts",
-        "default": "./dist/components/index.mjs"
-      },
-      "require": {
         "types": "./dist/components/index.d.ts",
         "default": "./dist/components/index.js"
       },
+      "require": {
+        "types": "./dist/components/index.d.cts",
+        "default": "./dist/components/index.cjs"
+      },
       "default": {
-        "types": "./dist/components/index.d.mts",
-        "default": "./dist/components/index.mjs"
+        "types": "./dist/components/index.d.ts",
+        "default": "./dist/components/index.js"
       }
     },
     "./components/*": {
       "import": {
-        "types": "./dist/components/*.d.mts",
-        "default": "./dist/components/*.mjs"
-      },
-      "require": {
         "types": "./dist/components/*.d.ts",
         "default": "./dist/components/*.js"
       },
+      "require": {
+        "types": "./dist/components/*.d.cts",
+        "default": "./dist/components/*.cjs"
+      },
       "default": {
-        "types": "./dist/components/*.d.mts",
-        "default": "./dist/components/*.mjs"
+        "types": "./dist/components/*.d.ts",
+        "default": "./dist/components/*.js"
       }
     },
     "./babel": {
       "import": {
-        "types": "./dist/babel/index.d.mts",
-        "default": "./dist/babel/index.mjs"
-      },
-      "require": {
         "types": "./dist/babel/index.d.ts",
         "default": "./dist/babel/index.js"
       },
+      "require": {
+        "types": "./dist/babel/index.d.cts",
+        "default": "./dist/babel/index.cjs"
+      },
       "default": {
-        "types": "./dist/babel/index.d.mts",
-        "default": "./dist/babel/index.mjs"
+        "types": "./dist/babel/index.d.ts",
+        "default": "./dist/babel/index.js"
       }
     },
     "./babel/*": {
       "import": {
-        "types": "./dist/babel/*.d.mts",
-        "default": "./dist/babel/*.mjs"
-      },
-      "require": {
         "types": "./dist/babel/*.d.ts",
         "default": "./dist/babel/*.js"
       },
+      "require": {
+        "types": "./dist/babel/*.d.cts",
+        "default": "./dist/babel/*.cjs"
+      },
       "default": {
-        "types": "./dist/babel/*.d.mts",
-        "default": "./dist/babel/*.mjs"
+        "types": "./dist/babel/*.d.ts",
+        "default": "./dist/babel/*.js"
       }
     }
   },
@@ -185,29 +179,29 @@
     "@alloy-js/typescript": "^0.20.0",
     "@babel/core": "^7.28.5",
     "@babel/types": "^7.28.5",
-    "@powerlines/alloy": "^0.11.8",
-    "@powerlines/plugin-babel": "^0.12.8",
-    "@powerlines/plugin-plugin": "^0.11.7",
-    "@storm-software/config-tools": "^1.188.13",
-    "@stryke/capnp": "^0.12.12",
-    "@stryke/env": "^0.20.5",
-    "@stryke/fs": "^0.32.3",
+    "@powerlines/alloy": "^0.11.9",
+    "@powerlines/plugin-babel": "^0.12.9",
+    "@powerlines/plugin-plugin": "^0.11.8",
+    "@storm-software/config-tools": "^1.188.19",
+    "@stryke/capnp": "^0.12.18",
+    "@stryke/env": "^0.20.11",
+    "@stryke/fs": "^0.32.10",
     "@stryke/json": "^0.9.3",
     "@stryke/string-format": "^0.12.0",
     "@stryke/type-checks": "^0.3.10",
     "@stryke/types": "^0.10.0",
-    "powerlines": "^0.14.1"
+    "powerlines": "^0.15.0"
   },
   "devDependencies": {
     "@alloy-js/babel-preset": "^0.2.1",
     "@babel/preset-typescript": "^7.28.5",
-    "@powerlines/nx": "^0.9.5",
-    "@storm-software/tsup": "^0.2.11",
-    "@types/node": "^22.18.12",
+    "@powerlines/nx": "^0.10.0",
+    "@storm-software/tsup": "^0.2.17",
+    "@types/node": "^22.19.0",
     "tsup": "8.4.0",
     "typescript": "^5.9.3",
-    "vite": "^7.1.12"
+    "vite": "^7.2.0"
   },
   "publishConfig": { "access": "public" },
-  "gitHead": "284d279fb9c466a627d4506600e0d16315ec96ac"
+  "gitHead": "b64f9a9d53b6eb8054c361da347f6623a7ba9e45"
 }