@powerlines/plugin-oxc-transform 0.5.67 → 0.5.69

package/dist/powerlines/src/types/fs.d.mts

@@ -0,0 +1,458 @@
+import { MaybePromise } from "@stryke/types/base";
+import { AssetGlob } from "@stryke/types/file";
+import { ResolveOptions } from "@stryke/fs/resolve";
+
+//#region ../powerlines/src/types/fs.d.ts
+
+type StoragePreset = "fs" | "virtual";
+/**
+ * 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;
+  /**
+   * Creates a directory at the specified path.
+   *
+   * @param dirPath - The path of the directory to create.
+   */
+  mkdir: (dirPath: string) => Promise<void>;
+  /**
+   * Synchronously creates a directory at the specified path.
+   *
+   * @param dirPath - The path of the directory to create.
+   */
+  mkdirSync: (dirPath: 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[];
+  /**
+   * Checks if the given key is a directory.
+   *
+   * @param key - The key to check.
+   * @returns A promise that resolves to `true` if the key is a directory, otherwise `false`.
+   */
+  isDirectory: (key: string) => Promise<boolean>;
+  /**
+   * Synchronously checks if the given key is a directory.
+   *
+   * @param key - The key to check.
+   * @returns `true` if the key is a directory, otherwise `false`.
+   */
+  isDirectorySync: (key: string) => boolean;
+  /**
+   * Checks if the given key is a file.
+   *
+   * @param key - The key to check.
+   * @returns A promise that resolves to `true` if the key is a file, otherwise `false`.
+   */
+  isFile: (key: string) => Promise<boolean>;
+  /**
+   * Synchronously checks if the given key is a file.
+   *
+   * @param key - The key to check.
+   * @returns `true` if the key is a file, otherwise `false`.
+   */
+  isFileSync: (key: string) => boolean;
+  /**
+   * 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$1 extends ResolveOptions {
+  /**
+   * 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;
+  /**
+   * Checks if the given key is a directory.
+   *
+   * @param key - The key to check.
+   * @returns A promise that resolves to `true` if the key is a directory, otherwise `false`.
+   */
+  isDirectory: (key: string) => Promise<boolean>;
+  /**
+   * Synchronously checks if the given key is a directory.
+   *
+   * @param key - The key to check.
+   * @returns `true` if the key is a directory, otherwise `false`.
+   */
+  isDirectorySync: (key: string) => boolean;
+  /**
+   * Checks if the given key is a file.
+   *
+   * @param key - The key to check.
+   * @returns A promise that resolves to `true` if the key is a file, otherwise `false`.
+   */
+  isFile: (key: string) => Promise<boolean>;
+  /**
+   * Synchronously checks if the given key is a file.
+   *
+   * @param key - The key to check.
+   * @returns `true` if the key is a file, otherwise `false`.
+   */
+  isFileSync: (key: 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;
+  /**
+   * Creates a directory at the specified path.
+   *
+   * @param dirPath - The path of the directory to create.
+   */
+  mkdir: (dirPath: string) => Promise<void>;
+  /**
+   * Synchronously creates a directory at the specified path.
+   *
+   * @param dirPath - The path of the directory to create.
+   */
+  mkdirSync: (dirPath: string) => 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 | URL | Omit<AssetGlob, "output">, destPath: string | URL) => 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 | URL | Omit<AssetGlob, "output">, destPath: string | URL) => 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: (patterns: string | Omit<AssetGlob, "output"> | (string | Omit<AssetGlob, "output">)[]) => 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: (patterns: string | Omit<AssetGlob, "output"> | (string | Omit<AssetGlob, "output">)[]) => 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$1) => 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$1) => string | undefined;
+  /**
+   * Disposes of the virtual file system (VFS), writes any virtual file changes to disk, and releases any associated resources.
+   */
+  dispose: () => Promise<void>;
+}
+//#endregion
+export { ResolveOptions$1 as ResolveOptions, StoragePort, StoragePreset, VirtualFile, VirtualFileSystemInterface };

package/dist/powerlines/src/types/plugin.d.cts

@@ -0,0 +1,232 @@
+import { UnpluginBuildVariant } from "./build.cjs";
+import { EnvironmentConfig, PluginConfig } from "./config.cjs";
+import { EnvironmentResolvedConfig, ResolvedConfig } from "./resolved.cjs";
+import { BuildPluginContext, PluginContext, UnresolvedContext } from "./context.cjs";
+import { CommandType } from "./commands.cjs";
+import { ArrayValues } from "@stryke/types/array";
+import { FunctionLike, MaybePromise } from "@stryke/types/base";
+import { ExternalIdResult, HookFilter, TransformResult, UnpluginOptions } from "unplugin";
+
+//#region ../powerlines/src/types/plugin.d.ts
+interface PluginHookObject<THookFunction extends FunctionLike, TFilter extends keyof HookFilter = never> {
+  /**
+   * The order in which the plugin should be applied.
+   */
+  order?: "pre" | "post" | null | undefined;
+  /**
+   * A filter to determine when the hook should be called.
+   */
+  filter?: Pick<HookFilter, TFilter>;
+  /**
+   * The hook function to be called.
+   */
+  handler: THookFunction;
+}
+type PluginHook<THookFunction extends FunctionLike, TFilter extends keyof HookFilter = never> = THookFunction | PluginHookObject<THookFunction, TFilter>;
+/**
+ * A result returned by the plugin from the `types` hook that describes the declaration types output file.
+ */
+interface TypesResult {
+  directives?: string[];
+  code: string;
+}
+type DeepPartial<T> = { [K in keyof T]?: DeepPartial<T[K]> };
+type ConfigResult<TContext extends PluginContext = PluginContext> = DeepPartial<TContext["config"]> & Record<string, any>;
+interface BasePluginHookFunctions<TContext extends PluginContext = PluginContext> extends Record<CommandType, (this: TContext) => MaybePromise<void>> {
+  /**
+   * A function that returns configuration options to be merged with the build context's options.
+   *
+   * @remarks
+   * Modify config before it's resolved. The hook can either mutate {@link Context.config} on the passed-in context directly, or return a partial config object that will be deeply merged into existing config.
+   *
+   * @warning User plugins are resolved before running this hook so injecting other plugins inside the config hook will have no effect. If you want to add plugins, consider doing so in the {@link Plugin.dependsOn} property instead.
+   *
+   * @see https://vitejs.dev/guide/api-plugin#config
+   *
+   * @param this - The build context.
+   * @param config - The partial configuration object to be modified.
+   * @returns A promise that resolves to a partial configuration object.
+   */
+  config: (this: UnresolvedContext<TContext["config"]>) => MaybePromise<ConfigResult<TContext>>;
+  /**
+   * Modify environment configs before it's resolved. The hook can either mutate the passed-in environment config directly, or return a partial config object that will be deeply merged into existing config.
+   *
+   * @remarks
+   * This hook is called for each environment with a partially resolved environment config that already accounts for the default environment config values set at the root level. If plugins need to modify the config of a given environment, they should do it in this hook instead of the config hook. Leaving the config hook only for modifying the root default environment config.
+   *
+   * @see https://vitejs.dev/guide/api-plugin#configenvironment
+   *
+   * @param this - The build context.
+   * @param name - The name of the environment being configured.
+   * @param environment - The Vite-like environment object containing information about the current build environment.
+   * @returns A promise that resolves when the hook is complete.
+   */
+  configEnvironment: (this: TContext, name: string, environment: EnvironmentConfig) => MaybePromise<Partial<EnvironmentResolvedConfig> | undefined | null>;
+  /**
+   * A hook that is called when the plugin is resolved.
+   *
+   * @see https://vitejs.dev/guide/api-plugin#configresolved
+   *
+   * @param this - The build context.
+   * @returns A promise that resolves when the hook is complete.
+   */
+  configResolved: (this: TContext) => MaybePromise<void>;
+  /**
+   * A hook that is called to overwrite the generated declaration types file (.d.ts). The generated type definitions should describe the built-in modules/logic added during the `prepare` task.
+   *
+   * @param this - The build context.
+   * @param code - The source code to generate types for.
+   * @returns A promise that resolves when the hook is complete.
+   */
+  types: (this: TContext, code: string) => MaybePromise<TypesResult | string | undefined | null>;
+  /**
+   * A hook that is called at the start of the build process.
+   *
+   * @param this - The build context and unplugin build context.
+   * @returns A promise that resolves when the hook is complete.
+   */
+  buildStart: (this: BuildPluginContext<TContext["config"]> & TContext) => MaybePromise<void>;
+  /**
+   * A hook that is called at the end of the build process.
+   *
+   * @param this - The build context and unplugin build context.
+   * @returns A promise that resolves when the hook is complete.
+   */
+  buildEnd: (this: BuildPluginContext<TContext["config"]> & TContext) => MaybePromise<void>;
+  /**
+   * A hook that is called to transform the source code.
+   *
+   * @param this - The build context, unplugin build context, and unplugin context.
+   * @param code - The source code to transform.
+   * @param id - The identifier of the source code.
+   * @returns A promise that resolves when the hook is complete.
+   */
+  transform: (this: BuildPluginContext<TContext["config"]> & TContext, code: string, id: string) => MaybePromise<TransformResult>;
+  /**
+   * A hook that is called to load the source code.
+   *
+   * @param this - The build context, unplugin build context, and unplugin context.
+   * @param id - The identifier of the source code.
+   * @returns A promise that resolves when the hook is complete.
+   */
+  load: (this: BuildPluginContext<TContext["config"]> & TContext, id: string) => MaybePromise<TransformResult>;
+  /**
+   * A hook that is called to resolve the identifier of the source code.
+   *
+   * @param this - The build context, unplugin build context, and unplugin context.
+   * @param id - The identifier of the source code.
+   * @param importer - The importer of the source code.
+   * @param options - The options for resolving the identifier.
+   * @returns A promise that resolves when the hook is complete.
+   */
+  resolveId: (this: BuildPluginContext<TContext["config"]> & TContext, id: string, importer: string | undefined, options: {
+    isEntry: boolean;
+  }) => MaybePromise<string | ExternalIdResult | null | undefined>;
+  /**
+   * A hook that is called to write the bundle to disk.
+   *
+   * @param this - The build context.
+   * @returns A promise that resolves when the hook is complete.
+   */
+  writeBundle: (this: TContext) => MaybePromise<void>;
+}
+type BuildPlugin<TContext extends PluginContext = PluginContext, TBuildVariant$1 extends UnpluginBuildVariant = UnpluginBuildVariant, TOptions extends Required<UnpluginOptions>[TBuildVariant$1] = Required<UnpluginOptions>[TBuildVariant$1]> = { [TKey in keyof TOptions]: TOptions[TKey] extends FunctionLike ? (this: ThisParameterType<TOptions[TKey]> & TContext, ...args: Parameters<TOptions[TKey]>) => ReturnType<TOptions[TKey]> | MaybePromise<ReturnType<TOptions[TKey]>> : TOptions[TKey] };
+type PluginHooks<TContext extends PluginContext = PluginContext> = { [TKey in keyof BasePluginHookFunctions<TContext>]: PluginHook<BasePluginHookFunctions<TContext>[TKey]> } & {
+  /**
+   * A function that returns configuration options to be merged with the build context's options.
+   *
+   * @remarks
+   * Modify config before it's resolved. The hook can either mutate {@link Context.config} on the passed-in context directly, or return a partial config object that will be deeply merged into existing config.
+   *
+   * @warning User plugins are resolved before running this hook so injecting other plugins inside the config hook will have no effect. If you want to add plugins, consider doing so in the {@link Plugin.dependsOn} property instead.
+   *
+   * @see https://vitejs.dev/guide/api-plugin#config
+   *
+   * @param this - The build context.
+   * @param config - The partial configuration object to be modified.
+   * @returns A promise that resolves to a partial configuration object.
+   */
+  config: PluginHook<(this: UnresolvedContext<TContext["config"]>) => MaybePromise<ConfigResult<TContext>>> | ConfigResult<TContext>;
+  /**
+   * A hook that is called to transform the source code.
+   *
+   * @param this - The build context, unplugin build context, and unplugin context.
+   * @param code - The source code to transform.
+   * @param id - The identifier of the source code.
+   * @returns A promise that resolves when the hook is complete.
+   */
+  transform: PluginHook<(this: BuildPluginContext<TContext["config"]> & TContext, code: string, id: string) => MaybePromise<TransformResult>, "code" | "id">;
+  /**
+   * A hook that is called to load the source code.
+   *
+   * @param this - The build context, unplugin build context, and unplugin context.
+   * @param id - The identifier of the source code.
+   * @returns A promise that resolves when the hook is complete.
+   */
+  load: PluginHook<(this: BuildPluginContext<TContext["config"]> & TContext, id: string) => MaybePromise<TransformResult>, "id">;
+  /**
+   * A hook that is called to resolve the identifier of the source code.
+   *
+   * @param this - The build context, unplugin build context, and unplugin context.
+   * @param id - The identifier of the source code.
+   * @param importer - The importer of the source code.
+   * @param options - The options for resolving the identifier.
+   * @returns A promise that resolves when the hook is complete.
+   */
+  resolveId: PluginHook<(this: BuildPluginContext<TContext["config"]> & TContext, id: string, importer: string | undefined, options: {
+    isEntry: boolean;
+  }) => MaybePromise<string | ExternalIdResult | null | undefined>, "id">;
+};
+type PluginBuildPlugins<TContext extends PluginContext = PluginContext> = { [TBuildVariant in UnpluginBuildVariant]?: BuildPlugin<TContext, TBuildVariant> };
+interface Plugin<in out TContext extends PluginContext<ResolvedConfig> = PluginContext<ResolvedConfig>> extends Partial<PluginHooks<TContext>>, PluginBuildPlugins<TContext> {
+  /**
+   * The name of the plugin, for use in deduplication, error messages and logs.
+   */
+  name: string;
+  /**
+   * An API object that can be used for inter-plugin communication.
+   *
+   * @see https://rollupjs.org/plugin-development/#direct-plugin-communication
+   */
+  api?: Record<string, any>;
+  /**
+   * Enforce plugin invocation tier similar to webpack loaders. Hooks ordering is still subject to the `order` property in the hook object.
+   *
+   * @remarks
+   * The Plugin invocation order is as follows:
+   * - `enforce: 'pre'` plugins
+   * - `order: 'pre'` plugin hooks
+   * - any other plugins (normal)
+   * - `order: 'post'` plugin hooks
+   * - `enforce: 'post'` plugins
+   *
+   * @see https://vitejs.dev/guide/api-plugin.html#plugin-ordering
+   * @see https://rollupjs.org/plugin-development/#build-hooks
+   * @see https://webpack.js.org/concepts/loaders/#enforce---pre-and-post
+   * @see https://esbuild.github.io/plugins/#concepts
+   */
+  enforce?: "pre" | "post";
+  /**
+   * A function to determine if two plugins are the same and can be de-duplicated.
+   *
+   * @remarks
+   * If this is not provided, plugins are de-duplicated by comparing their names.
+   *
+   * @param other - The other plugin to compare against.
+   * @returns `true` if the two plugins are the same, `false` otherwise.
+   */
+  dedupe?: false | ((other: Plugin<any>) => boolean);
+  /**
+   * A list of pre-requisite plugins that must be loaded before this plugin can be used.
+   */
+  dependsOn?: PluginConfig<any>[];
+  /**
+   * Define environments where this plugin should be active. By default, the plugin is active in all environments.
+   *
+   * @param environment - The environment to check.
+   * @returns `true` if the plugin should be active in the specified environment, `false` otherwise.
+   */
+  applyToEnvironment?: (environment: EnvironmentResolvedConfig) => boolean | PluginConfig<any>;
+}
+//#endregion
+export { Plugin };