@powerlines/plugin-satori 0.1.122 → 0.1.123

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

@@ -0,0 +1,69 @@
+import { CompilerOptions, TsConfigJson } from "@stryke/types/tsconfig";
+import ts from "typescript";
+
+//#region ../powerlines/src/types/tsconfig.d.ts
+type ReflectionMode = "default" | "explicit" | "never";
+type RawReflectionMode = ReflectionMode | "" | boolean | string | string[] | undefined;
+/**
+ * Defines the level of reflection to be used during the transpilation process.
+ *
+ * @remarks
+ * The level determines how much extra data is captured in the byte code for each type. This can be one of the following values:
+ * - `minimal` - Only the essential type information is captured.
+ * - `normal` - Additional type information is captured, including some contextual data.
+ * - `verbose` - All available type information is captured, including detailed contextual data.
+ */
+type ReflectionLevel = "minimal" | "normal" | "verbose";
+interface DeepkitOptions {
+  /**
+   * Either true to activate reflection for all files compiled using this tsconfig,
+   * or a list of globs/file paths relative to this tsconfig.json.
+   * Globs/file paths can be prefixed with a ! to exclude them.
+   */
+  reflection?: RawReflectionMode;
+  /**
+   * Defines the level of reflection to be used during the transpilation process.
+   *
+   * @remarks
+   * The level determines how much extra data is captured in the byte code for each type. This can be one of the following values:
+   * - `minimal` - Only the essential type information is captured.
+   * - `normal` - Additional type information is captured, including some contextual data.
+   * - `verbose` - All available type information is captured, including detailed contextual data.
+   */
+  reflectionLevel?: ReflectionLevel;
+}
+type TSCompilerOptions = CompilerOptions & DeepkitOptions;
+/**
+ * The TypeScript compiler configuration.
+ *
+ * @see https://www.typescriptlang.org/docs/handbook/tsconfig-json.html
+ */
+interface TSConfig extends Omit<TsConfigJson, "reflection"> {
+  /**
+   * Either true to activate reflection for all files compiled using this tsconfig,
+   * or a list of globs/file paths relative to this tsconfig.json.
+   * Globs/file paths can be prefixed with a ! to exclude them.
+   */
+  reflection?: RawReflectionMode;
+  /**
+   * Defines the level of reflection to be used during the transpilation process.
+   *
+   * @remarks
+   * The level determines how much extra data is captured in the byte code for each type. This can be one of the following values:
+   * - `minimal` - Only the essential type information is captured.
+   * - `normal` - Additional type information is captured, including some contextual data.
+   * - `verbose` - All available type information is captured, including detailed contextual data.
+   */
+  reflectionLevel?: ReflectionLevel;
+  /**
+   * Instructs the TypeScript compiler how to compile `.ts` files.
+   */
+  compilerOptions?: TSCompilerOptions;
+}
+type ParsedTypeScriptConfig = ts.ParsedCommandLine & {
+  originalTsconfigJson: TsConfigJson;
+  tsconfigJson: TSConfig;
+  tsconfigFilePath: string;
+};
+//#endregion
+export { ParsedTypeScriptConfig, TSConfig };

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

@@ -0,0 +1,69 @@
+import { CompilerOptions, TsConfigJson } from "@stryke/types/tsconfig";
+import ts from "typescript";
+
+//#region ../powerlines/src/types/tsconfig.d.ts
+type ReflectionMode = "default" | "explicit" | "never";
+type RawReflectionMode = ReflectionMode | "" | boolean | string | string[] | undefined;
+/**
+ * Defines the level of reflection to be used during the transpilation process.
+ *
+ * @remarks
+ * The level determines how much extra data is captured in the byte code for each type. This can be one of the following values:
+ * - `minimal` - Only the essential type information is captured.
+ * - `normal` - Additional type information is captured, including some contextual data.
+ * - `verbose` - All available type information is captured, including detailed contextual data.
+ */
+type ReflectionLevel = "minimal" | "normal" | "verbose";
+interface DeepkitOptions {
+  /**
+   * Either true to activate reflection for all files compiled using this tsconfig,
+   * or a list of globs/file paths relative to this tsconfig.json.
+   * Globs/file paths can be prefixed with a ! to exclude them.
+   */
+  reflection?: RawReflectionMode;
+  /**
+   * Defines the level of reflection to be used during the transpilation process.
+   *
+   * @remarks
+   * The level determines how much extra data is captured in the byte code for each type. This can be one of the following values:
+   * - `minimal` - Only the essential type information is captured.
+   * - `normal` - Additional type information is captured, including some contextual data.
+   * - `verbose` - All available type information is captured, including detailed contextual data.
+   */
+  reflectionLevel?: ReflectionLevel;
+}
+type TSCompilerOptions = CompilerOptions & DeepkitOptions;
+/**
+ * The TypeScript compiler configuration.
+ *
+ * @see https://www.typescriptlang.org/docs/handbook/tsconfig-json.html
+ */
+interface TSConfig extends Omit<TsConfigJson, "reflection"> {
+  /**
+   * Either true to activate reflection for all files compiled using this tsconfig,
+   * or a list of globs/file paths relative to this tsconfig.json.
+   * Globs/file paths can be prefixed with a ! to exclude them.
+   */
+  reflection?: RawReflectionMode;
+  /**
+   * Defines the level of reflection to be used during the transpilation process.
+   *
+   * @remarks
+   * The level determines how much extra data is captured in the byte code for each type. This can be one of the following values:
+   * - `minimal` - Only the essential type information is captured.
+   * - `normal` - Additional type information is captured, including some contextual data.
+   * - `verbose` - All available type information is captured, including detailed contextual data.
+   */
+  reflectionLevel?: ReflectionLevel;
+  /**
+   * Instructs the TypeScript compiler how to compile `.ts` files.
+   */
+  compilerOptions?: TSCompilerOptions;
+}
+type ParsedTypeScriptConfig = ts.ParsedCommandLine & {
+  originalTsconfigJson: TsConfigJson;
+  tsconfigJson: TSConfig;
+  tsconfigFilePath: string;
+};
+//#endregion
+export { ParsedTypeScriptConfig, TSConfig };

package/dist/types/index.cjs

@@ -1,3 +0,0 @@
-require('../module-DTH7_i6X.cjs');
-require('../plugin-B-8QVe28.cjs');
-require('../types-CBTc19th.cjs');

package/dist/types/index.d.cts

@@ -1,4 +1,3 @@
-import { a as __ΩSatoriPluginContext, c as __ΩSatoriPluginUserConfig, i as SatoriPluginUserConfig, n as SatoriPluginOptions, o as __ΩSatoriPluginOptions, r as SatoriPluginResolvedConfig, s as __ΩSatoriPluginResolvedConfig, t as SatoriPluginContext } from "../plugin-DTFyaBO6.cjs";
-import { n as __ΩSatoriComponentModule, t as SatoriComponentModule } from "../module-dJs7y8S5.cjs";
-import "../index-CmCelmEL.cjs";
+import { SatoriPluginContext, SatoriPluginOptions, SatoriPluginResolvedConfig, SatoriPluginUserConfig, __ΩSatoriPluginContext, __ΩSatoriPluginOptions, __ΩSatoriPluginResolvedConfig, __ΩSatoriPluginUserConfig } from "./plugin.cjs";
+import { SatoriComponentModule, __ΩSatoriComponentModule } from "./module.cjs";
 export { SatoriComponentModule, SatoriPluginContext, SatoriPluginOptions, SatoriPluginResolvedConfig, SatoriPluginUserConfig, __ΩSatoriComponentModule, __ΩSatoriPluginContext, __ΩSatoriPluginOptions, __ΩSatoriPluginResolvedConfig, __ΩSatoriPluginUserConfig };

package/dist/types/index.d.mts

@@ -1,4 +1,3 @@
-import { a as __ΩSatoriPluginContext, c as __ΩSatoriPluginUserConfig, i as SatoriPluginUserConfig, n as SatoriPluginOptions, o as __ΩSatoriPluginOptions, r as SatoriPluginResolvedConfig, s as __ΩSatoriPluginResolvedConfig, t as SatoriPluginContext } from "../plugin-YUvr66rC.mjs";
-import { n as __ΩSatoriComponentModule, t as SatoriComponentModule } from "../module-DWfSYSuA.mjs";
-import "../index-CA4VvAY_.mjs";
+import { SatoriPluginContext, SatoriPluginOptions, SatoriPluginResolvedConfig, SatoriPluginUserConfig, __ΩSatoriPluginContext, __ΩSatoriPluginOptions, __ΩSatoriPluginResolvedConfig, __ΩSatoriPluginUserConfig } from "./plugin.mjs";
+import { SatoriComponentModule, __ΩSatoriComponentModule } from "./module.mjs";
 export { SatoriComponentModule, SatoriPluginContext, SatoriPluginOptions, SatoriPluginResolvedConfig, SatoriPluginUserConfig, __ΩSatoriComponentModule, __ΩSatoriPluginContext, __ΩSatoriPluginOptions, __ΩSatoriPluginResolvedConfig, __ΩSatoriPluginUserConfig };

package/dist/types/index.mjs

@@ -1,5 +1 @@
-import "../module-BjH2GuD9.mjs";
-import "../plugin-B7p8VtjC.mjs";
-import "../types-BReKsBV6.mjs";
-
 export {  };

package/dist/types/module.cjs

@@ -1 +0,0 @@
-require('../module-DTH7_i6X.cjs');

package/dist/types/module.d.cts

@@ -1,2 +1,11 @@
-import { n as __ΩSatoriComponentModule, t as SatoriComponentModule } from "../module-dJs7y8S5.cjs";
+import { SatoriOptions } from "satori";
+import { ReactNode } from "react";
+
+//#region src/types/module.d.ts
+interface SatoriComponentModule {
+  default: ReactNode;
+  options?: SatoriOptions;
+}
+declare type __ΩSatoriComponentModule = any[];
+//#endregion
 export { SatoriComponentModule, __ΩSatoriComponentModule };

package/dist/types/module.d.mts

@@ -1,2 +1,11 @@
-import { n as __ΩSatoriComponentModule, t as SatoriComponentModule } from "../module-DWfSYSuA.mjs";
+import { SatoriOptions } from "satori";
+import { ReactNode } from "react";
+
+//#region src/types/module.d.ts
+interface SatoriComponentModule {
+  default: ReactNode;
+  options?: SatoriOptions;
+}
+declare type __ΩSatoriComponentModule = any[];
+//#endregion
 export { SatoriComponentModule, __ΩSatoriComponentModule };

package/dist/types/module.mjs

@@ -1,3 +1 @@
-import "../module-BjH2GuD9.mjs";
-
 export {  };

package/dist/types/plugin.cjs

@@ -1 +0,0 @@
-require('../plugin-B-8QVe28.cjs');

package/dist/types/plugin.d.cts

@@ -1,2 +1,47 @@
-import { a as __ΩSatoriPluginContext, c as __ΩSatoriPluginUserConfig, i as SatoriPluginUserConfig, n as SatoriPluginOptions, o as __ΩSatoriPluginOptions, r as SatoriPluginResolvedConfig, s as __ΩSatoriPluginResolvedConfig, t as SatoriPluginContext } from "../plugin-DTFyaBO6.cjs";
+import { UserConfig } from "../powerlines/src/types/config.cjs";
+import { ResolvedConfig } from "../powerlines/src/types/resolved.cjs";
+import { PluginContext } from "../powerlines/src/types/context.cjs";
+import { SatoriOptions } from "satori";
+
+//#region src/types/plugin.d.ts
+interface SatoriPluginOptions {
+  /**
+   * A path or glob pattern (or an array of paths and glob patterns) to files that have a Satori component default export.
+   */
+  path: string | string[];
+  /**
+   * The path for the generated Satori output images
+   *
+   * @remarks
+   * By default, it will generate the output files alongside each satori component file.
+   */
+  outputPath?: string;
+  /**
+   * Default Satori options to apply to all components.
+   *
+   * @remarks
+   * These options can be overridden by individual component modules that export their own options.
+   */
+  defaultOptions?: Partial<SatoriOptions>;
+}
+interface SatoriPluginUserConfig extends UserConfig {
+  satori?: Omit<SatoriPluginOptions, "defaultOptions"> & Required<Pick<SatoriPluginOptions, "defaultOptions">>;
+}
+interface SatoriPluginResolvedConfig extends ResolvedConfig {
+  satori: Omit<SatoriPluginOptions, "defaultOptions"> & Required<Pick<SatoriPluginOptions, "defaultOptions">> & {
+    /**
+     * An array of resolved input file paths containing Satori components.
+     *
+     * @remarks
+     * These paths are determined based on the {@link SatoriPluginOptions.path} option provided in the plugin configuration. These are **not** glob patterns, but the actual resolved file paths.
+     */
+    inputs: string[];
+  };
+}
+type SatoriPluginContext<TResolvedConfig extends SatoriPluginResolvedConfig = SatoriPluginResolvedConfig> = PluginContext<TResolvedConfig>;
+declare type __ΩSatoriPluginOptions = any[];
+declare type __ΩSatoriPluginUserConfig = any[];
+declare type __ΩSatoriPluginResolvedConfig = any[];
+declare type __ΩSatoriPluginContext = any[];
+//#endregion
 export { SatoriPluginContext, SatoriPluginOptions, SatoriPluginResolvedConfig, SatoriPluginUserConfig, __ΩSatoriPluginContext, __ΩSatoriPluginOptions, __ΩSatoriPluginResolvedConfig, __ΩSatoriPluginUserConfig };

package/dist/types/plugin.d.mts

@@ -1,2 +1,47 @@
-import { a as __ΩSatoriPluginContext, c as __ΩSatoriPluginUserConfig, i as SatoriPluginUserConfig, n as SatoriPluginOptions, o as __ΩSatoriPluginOptions, r as SatoriPluginResolvedConfig, s as __ΩSatoriPluginResolvedConfig, t as SatoriPluginContext } from "../plugin-YUvr66rC.mjs";
+import { UserConfig } from "../powerlines/src/types/config.mjs";
+import { ResolvedConfig } from "../powerlines/src/types/resolved.mjs";
+import { PluginContext } from "../powerlines/src/types/context.mjs";
+import { SatoriOptions } from "satori";
+
+//#region src/types/plugin.d.ts
+interface SatoriPluginOptions {
+  /**
+   * A path or glob pattern (or an array of paths and glob patterns) to files that have a Satori component default export.
+   */
+  path: string | string[];
+  /**
+   * The path for the generated Satori output images
+   *
+   * @remarks
+   * By default, it will generate the output files alongside each satori component file.
+   */
+  outputPath?: string;
+  /**
+   * Default Satori options to apply to all components.
+   *
+   * @remarks
+   * These options can be overridden by individual component modules that export their own options.
+   */
+  defaultOptions?: Partial<SatoriOptions>;
+}
+interface SatoriPluginUserConfig extends UserConfig {
+  satori?: Omit<SatoriPluginOptions, "defaultOptions"> & Required<Pick<SatoriPluginOptions, "defaultOptions">>;
+}
+interface SatoriPluginResolvedConfig extends ResolvedConfig {
+  satori: Omit<SatoriPluginOptions, "defaultOptions"> & Required<Pick<SatoriPluginOptions, "defaultOptions">> & {
+    /**
+     * An array of resolved input file paths containing Satori components.
+     *
+     * @remarks
+     * These paths are determined based on the {@link SatoriPluginOptions.path} option provided in the plugin configuration. These are **not** glob patterns, but the actual resolved file paths.
+     */
+    inputs: string[];
+  };
+}
+type SatoriPluginContext<TResolvedConfig extends SatoriPluginResolvedConfig = SatoriPluginResolvedConfig> = PluginContext<TResolvedConfig>;
+declare type __ΩSatoriPluginOptions = any[];
+declare type __ΩSatoriPluginUserConfig = any[];
+declare type __ΩSatoriPluginResolvedConfig = any[];
+declare type __ΩSatoriPluginContext = any[];
+//#endregion
 export { SatoriPluginContext, SatoriPluginOptions, SatoriPluginResolvedConfig, SatoriPluginUserConfig, __ΩSatoriPluginContext, __ΩSatoriPluginOptions, __ΩSatoriPluginResolvedConfig, __ΩSatoriPluginUserConfig };

package/dist/types/plugin.mjs

@@ -1,3 +1 @@
-import "../plugin-B7p8VtjC.mjs";
-
 export {  };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@powerlines/plugin-satori",
-  "version": "0.1.122",
+  "version": "0.1.123",
   "type": "module",
   "description": "A Powerlines plugin to use Satori to generate SVG files from jsx/tsx components.",
   "repository": {
@@ -131,17 +131,17 @@
     "@stryke/types": "^0.10.29",
     "defu": "^6.1.4",
     "jiti": "^2.6.1",
-    "powerlines": "^0.36.27",
+    "powerlines": "^0.36.28",
     "satori": "^0.18.3"
   },
   "devDependencies": {
-    "@powerlines/nx": "^0.11.53",
-    "@powerlines/plugin-plugin": "^0.12.75",
+    "@powerlines/nx": "^0.11.54",
+    "@powerlines/plugin-plugin": "^0.12.76",
     "@storm-software/config": "^1.134.75",
     "@types/node": "^24.10.4",
     "@types/react": "^19.2.7",
     "@types/react-dom": "^19.2.3"
   },
   "publishConfig": { "access": "public" },
-  "gitHead": "fbc59ce584fd0f78d90d2dbaa18f9c9267bd3b61"
+  "gitHead": "6891ff1330798e807c4caef6134df09d9f57686d"
 }

package/dist/index-CA4VvAY_.d.mts

@@ -1 +0,0 @@
-export { };

package/dist/index-CmCelmEL.d.cts

@@ -1 +0,0 @@
-export { };

package/dist/module-BjH2GuD9.mjs

@@ -1 +0,0 @@
-export {  };

package/dist/module-DWfSYSuA.d.mts

@@ -1,11 +0,0 @@
-import { SatoriOptions } from "satori";
-import { ReactNode } from "react";
-
-//#region src/types/module.d.ts
-interface SatoriComponentModule {
-  default: ReactNode;
-  options?: SatoriOptions;
-}
-declare type __ΩSatoriComponentModule = any[];
-//#endregion
-export { __ΩSatoriComponentModule as n, SatoriComponentModule as t };

package/dist/module-dJs7y8S5.d.cts

@@ -1,11 +0,0 @@
-import { SatoriOptions } from "satori";
-import { ReactNode } from "react";
-
-//#region src/types/module.d.ts
-interface SatoriComponentModule {
-  default: ReactNode;
-  options?: SatoriOptions;
-}
-declare type __ΩSatoriComponentModule = any[];
-//#endregion
-export { __ΩSatoriComponentModule as n, SatoriComponentModule as t };

package/dist/plugin-B7p8VtjC.mjs

@@ -1 +0,0 @@
-export {  };