@powerlines/plugin-react 0.1.132 → 0.1.134

package/dist/{deepkit/schemas/reflection.d.mts → plugin-CJdK9GYW.d.cts}

@@ -1,5 +1,24 @@
+import { i as UserConfig, n as ResolvedConfig, o as PluginContext, r as BabelUserConfig, t as BabelResolvedConfig } from "./resolved-CTt23qfE.cjs";
+import { n as SecretsInterface, t as EnvInterface } from "./runtime-B8Zgz0Kb.cjs";
+import { Children, PrintTreeOptions } from "@alloy-js/core";
+import { DotenvConfiguration, TypeDefinition, TypeDefinitionParameter } from "@stryke/types/configuration";
+import { Children as Children$1 } from "@alloy-js/core/jsx-runtime";
+import { ReflectionClass } from "@powerlines/deepkit/vendor/type";
 import * as $ from "@stryke/capnp";
+import { Config } from "automd";
+import { DotenvParseOutput } from "@stryke/env/types";
+import { PluginOptions } from "babel-plugin-react-compiler";
 
+//#region ../plugin-babel/src/types/plugin.d.ts
+type BabelPluginOptions = Partial<BabelUserConfig>;
+type BabelPluginUserConfig = UserConfig;
+interface BabelPluginResolvedConfig extends ResolvedConfig {
+  transform: {
+    babel: BabelResolvedConfig;
+  };
+}
+type BabelPluginContext<TResolvedConfig extends BabelPluginResolvedConfig = BabelPluginResolvedConfig> = PluginContext<TResolvedConfig>;
+//#endregion
 //#region ../deepkit/schemas/reflection.d.ts
 declare const ReflectionKind: {
   readonly NEVER: 0;
@@ -1557,4 +1576,315 @@ declare class SerializedTypes extends $.Struct {
   toString(): string;
 }
 //#endregion
-export { SerializedTypes };
+//#region ../deepkit/src/types.d.ts
+type Reflection<T extends Record<string, any> = Record<string, any>> = ReflectionClass<T> & {
+  dataBuffer?: ArrayBuffer;
+  messageRoot?: SerializedTypes;
+};
+//#endregion
+//#region ../plugin-alloy/src/types/plugin.d.ts
+type AlloyPluginOptions = Partial<PrintTreeOptions> & {
+  /**
+   * If true, the Alloy framework is used to generate Typescript output files.
+   *
+   * @defaultValue true
+   */
+  typescript?: boolean;
+  /**
+   * If true, the Alloy framework is used to generate JSON output files.
+   *
+   * @defaultValue false
+   */
+  json?: boolean;
+  /**
+   * If true, the Alloy framework is used to generate Markdown output files.
+   *
+   * @defaultValue false
+   */
+  markdown?: boolean;
+};
+type AlloyPluginUserConfig = UserConfig & {
+  alloy?: AlloyPluginOptions;
+};
+type AlloyPluginResolvedConfig = ResolvedConfig & {
+  alloy: AlloyPluginOptions;
+};
+type AlloyPluginContext<TResolvedConfig extends AlloyPluginResolvedConfig = AlloyPluginResolvedConfig> = PluginContext<TResolvedConfig> & {
+  render: <TContext extends AlloyPluginContext>(this: TContext, children: Children) => Promise<void>;
+};
+//#endregion
+//#region ../plugin-automd/src/types/toc.d.ts
+interface TOCOptions {
+  /**
+   * A slugify function to generate slugs for the headings.
+   */
+  slugify?: (str: string) => string;
+  /**
+   * The maximum depth of headings to include in the TOC.
+   *
+   * @defaultValue 6
+   */
+  maxDepth?: number;
+  /**
+   * Whether to include the first H1 heading in the TOC.
+   */
+  firstH1?: boolean;
+  /**
+   * The bullet character to use for list items in the TOC.
+   *
+   * @defaultValue "-"
+   */
+  bullets?: string;
+  /**
+   * A prefix to add to each heading in the TOC.
+   */
+  prefix?: string;
+  /**
+   * A filter function to determine which headings to include in the TOC.
+   */
+  filter?: (str: string, level: number) => boolean;
+}
+//#endregion
+//#region ../plugin-automd/src/types/plugin.d.ts
+type AutoMDPluginOptions = Omit<Config, "dir" | "watch" | "onWatch" | "prefix"> & {
+  /**
+   * Path to the AutoMD configuration file.
+   *
+   * @remarks
+   * If not provided, the plugin will use the default AutoMD configuration resolution mechanism.
+   */
+  configFile?: string;
+  /**
+   * An indicator specifying whether or not issues found by AutoMD during the prepare task are considered fatal.
+   *
+   * @defaultValue true
+   */
+  allowIssues?: boolean;
+  /**
+   * Alternate prefix strings to use for finding generators
+   *
+   * @remarks
+   * By default, AutoMD looks for generators with the "automd" prefix, so that any `<!-- automd:generator [...args] --> ... <!-- /automd -->` comments will be picked up. If you want to use different prefixes (for example, to avoid conflicts with other tools), you would provide a value like "myPrefix" and AutoMD would also look for `<!-- myPrefix:generator [...args] --> ... <!-- /myPrefix -->` comments.
+   *
+   * @defaultValue ["automd", "powerlines", "\{framework\}"]
+   */
+  prefix?: string | string[];
+  /**
+   * Table of Contents generator options
+   *
+   * @remarks
+   * If set to `false`, the built-in Table of Contents generator will be disabled.
+   */
+  toc?: false | TOCOptions;
+};
+//#endregion
+//#region ../plugin-env/src/types/plugin.d.ts
+type EnvPluginOptions = Omit<DotenvConfiguration, "types"> & {
+  /**
+   * A path to the type definition for the expected env configuration parameters. This value can include both a path to the typescript file and the name of the type definition to use separated by a `":"` or `"#"` character. For example: `"./src/types/env.ts#ConfigConfiguration"`.
+   */
+  types?: TypeDefinitionParameter;
+  /**
+   * A path to the type definition for the expected env secret parameters. This value can include both a path to the typescript file and the name of the type definition to use separated by a `":"` or `"#"` character. For example: `"./src/types/env.ts#ConfigSecrets"`.
+   */
+  secrets?: TypeDefinitionParameter;
+  /**
+   * An additional prefix (or list of additional prefixes) to apply to the environment variables
+   *
+   * @remarks
+   * By default, the plugin will use the `POWERLINES_` prefix. This option is useful for avoiding conflicts with other environment variables.
+   */
+  prefix?: string | string[];
+  /**
+   * Should the plugin inject the env variables in the source code with their values?
+   *
+   * @remarks
+   * This option is set to `true` when building an application project.
+   *
+   * @defaultValue false
+   */
+  inject?: boolean;
+  /**
+   * The default configuration to use when loading environment variables.
+   *
+   * @remarks
+   * This configuration is used as the base configuration when loading environment variables, and will be overridden by any values found in the `.env` file or the process environment.
+   */
+  defaultConfig?: Children$1;
+  /**
+   * Babel configuration options to use when injecting environment variables into the source code.
+   *
+   * @remarks
+   * This option allows you to customize the Babel transformation process used to inject environment variables into the source code. If not provided, the plugin will use default Babel settings.
+   */
+  babel?: BabelPluginOptions;
+  /**
+   * AutoMD configuration options to allow injecting environment variables documentation into a markdown file such as a README.md.
+   *
+   * @remarks
+   * The README.md file should contain the `<!-- automd:env --><!-- /automd -->` comment block where the documentation will be injected.
+   */
+  automd?: AutoMDPluginOptions;
+  /**
+   * Alloy configuration options to use when injecting environment variables into the source code.
+   *
+   * @remarks
+   * This option allows you to customize the Alloy transformation process used to inject environment variables into the source code. If not provided, the plugin will use default Alloy settings.
+   */
+  alloy?: AlloyPluginOptions;
+};
+type EnvPluginUserConfig = BabelPluginUserConfig & AlloyPluginUserConfig & {
+  env: EnvPluginOptions;
+};
+type EnvPluginResolvedConfig = BabelPluginResolvedConfig & AlloyPluginResolvedConfig & {
+  env: Required<Pick<DotenvConfiguration, "additionalFiles">> & Required<Pick<EnvPluginOptions, "defaultConfig">> & {
+    /**
+     * The type definition for the expected env variable parameters
+     *
+     * @remarks
+     * This value is parsed from the {@link EnvPluginOptions.types} option.
+     */
+    types: TypeDefinition;
+    /**
+     * The type definition for the expected env secret parameters
+     *
+     * @remarks
+     * This value is parsed from the {@link EnvPluginOptions.secrets} option.
+     */
+    secrets: TypeDefinition;
+    /**
+     * Should the plugin inject the env variables in the source code with their values?
+     *
+     * @remarks
+     * This value is the result of reflecting the {@link EnvPluginOptions.inject} option.
+     */
+    inject: EnvPluginOptions["inject"];
+    /**
+     * The prefix used for environment variables
+     *
+     * @remarks
+     * This value is used to filter environment variables that are loaded from the .env file and the process environment.
+     */
+    prefix: string[];
+  };
+};
+interface EnvPluginContext<TResolvedConfig extends EnvPluginResolvedConfig = EnvPluginResolvedConfig> extends BabelPluginContext<TResolvedConfig>, AlloyPluginContext<TResolvedConfig> {
+  env: {
+    /**
+     * The type definitions reflection for the env variables and secrets
+     *
+     * @remarks
+     * These reflections contains the structure of the expected environment variables and secrets as defined by the type definitions provided in the plugin configuration.
+     */
+    types: {
+      /**
+       * The type definitions for the expected env variables
+       */
+      env: Reflection;
+      /**
+       * The type definitions for the expected env secrets
+       */
+      secrets: Reflection;
+    };
+    /**
+     * The current **used** environment variables and secrets reflection
+     *
+     * @remarks
+     * This reflection contains the structure of the current environment variables and secrets as defined during the plugin initialization by extracting the values from the source code.
+     */
+    used: {
+      /**
+       * The current env variables reflection
+       */
+      env: Reflection<EnvInterface>;
+      /**
+       * The current env secrets reflection
+       */
+      secrets: Reflection<SecretsInterface>;
+    };
+    /**
+     * The parsed .env configuration object
+     *
+     * @remarks
+     * This value is the result of loading the .env configuration file found in the project root directory and merging it with the values provided at {@link EnvPluginOptions.values}
+     */
+    parsed: DotenvParseOutput;
+    /**
+     * The injected environment variables and secrets reflection
+     *
+     * @remarks
+     * This reflection contains the structure of the injected environment variables and secrets that were injected into the source code during the build process.
+     */
+    injected: Reflection;
+  };
+}
+//#endregion
+//#region src/types/plugin.d.ts
+type ReactCompilerOptions = Omit<PluginOptions, "logger">;
+interface ReactPluginOptions {
+  /**
+   * Control where the JSX factory is imported from.
+   *
+   * @see https://esbuild.github.io/api/#jsx-import-source
+   *
+   * @defaultValue "react"
+   */
+  jsxImportSource?: string;
+  /**
+   * Control how JSX is transformed.
+   *
+   * @remarks
+   * Skipping React import with classic runtime is not supported from v4
+   *
+   * @defaultValue "automatic"
+   */
+  jsxRuntime?: "classic" | "automatic";
+  /**
+   * Options provided to the [React Compiler](https://npmjs.com/package/babel-plugin-react-compiler).
+   *
+   * @see https://github.com/facebook/react/blob/main/compiler/packages/babel-plugin-react-compiler/src/Entrypoint/Options.ts#L55
+   * @see https://react.dev/blog/2025/04/21/react-compiler-rc
+   *
+   * @remarks
+   * Set to `false` to disable the React Compiler. By default, the React Compiler is enabled and target is set to React 19.
+   */
+  compiler?: ReactCompilerOptions | false;
+  /**
+   * React Fast Refresh runtime URL prefix.
+   *
+   * @remarks
+   * Useful in a module federation context to enable HMR by specifying the host application URL in the Vite config of a remote application.
+   *
+   * @example
+   * reactRefreshHost: 'http://localhost:3000'
+   */
+  reactRefreshHost?: string;
+  /**
+   * Options to pass to the [Babel plugin](https://npmjs.com/package/\@powerlines/plugin-babel).
+   */
+  babel?: Partial<BabelPluginOptions>;
+  /**
+   * Options to pass to the [Env plugin](https://npmjs.com/package/\@powerlines/plugin-env).
+   */
+  env?: Partial<Omit<EnvPluginOptions, "babel">>;
+}
+type ReactPluginUserConfig = EnvPluginUserConfig & {
+  /**
+   * Options for the React plugin.
+   */
+  react?: ReactPluginOptions;
+};
+type ReactPluginResolvedConfig = EnvPluginResolvedConfig & {
+  /**
+   * Options for the React plugin.
+   */
+  react: ReactPluginOptions;
+};
+interface ReactPluginContext<TResolvedConfig extends ReactPluginResolvedConfig = ReactPluginResolvedConfig> extends EnvPluginContext<TResolvedConfig> {}
+declare type __ΩReactCompilerOptions = any[];
+declare type __ΩReactPluginOptions = any[];
+declare type __ΩReactPluginUserConfig = any[];
+declare type __ΩReactPluginResolvedConfig = any[];
+declare type __ΩReactPluginContext = any[];
+//#endregion
+export { ReactPluginUserConfig as a, __ΩReactPluginOptions as c, ReactPluginResolvedConfig as i, __ΩReactPluginResolvedConfig as l, ReactPluginContext as n, __ΩReactCompilerOptions as o, ReactPluginOptions as r, __ΩReactPluginContext as s, ReactCompilerOptions as t, __ΩReactPluginUserConfig as u };