@powerlines/plugin-satori 0.1.337 → 0.1.339

package/dist/index.d.cts

@@ -0,0 +1,21 @@
+import { SatoriPluginContext, SatoriPluginOptions, SatoriPluginResolvedConfig, SatoriPluginUserConfig, __ΩSatoriPluginContext, __ΩSatoriPluginOptions, __ΩSatoriPluginResolvedConfig, __ΩSatoriPluginUserConfig } from "./types/plugin.cjs";
+import { SatoriComponentModule, __ΩSatoriComponentModule } from "./types/module.cjs";
+import "./types/index.cjs";
+import { Plugin } from "powerlines";
+
+//#region src/index.d.ts
+declare module "powerlines" {
+  interface Config {
+    satori?: SatoriPluginOptions;
+  }
+}
+/**
+ * A Powerlines plugin to use Untyped for code generation based on user-defined schemas.
+ *
+ * @param options - The plugin options.
+ * @returns A Powerlines plugin instance.
+ */
+declare const plugin: <TContext extends SatoriPluginContext = SatoriPluginContext>(options: SatoriPluginOptions) => Plugin<TContext>;
+//#endregion
+export { SatoriComponentModule, SatoriPluginContext, SatoriPluginOptions, SatoriPluginResolvedConfig, SatoriPluginUserConfig, __ΩSatoriComponentModule, __ΩSatoriPluginContext, __ΩSatoriPluginOptions, __ΩSatoriPluginResolvedConfig, __ΩSatoriPluginUserConfig, plugin as default, plugin };
+//# sourceMappingURL=index.d.cts.map

package/dist/index.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.cts","names":[],"sources":["../src/index.ts"],"sourcesContent":[],"mappings":";;;;;;;;aAuCa;EAJW;;;;;AAcxB;;;AAGW,cAHE,MAGF,EAAA,CAAA,iBAFQ,mBAER,GAF8B,mBAE9B,CAAA,CAAA,OAAA,EAAA,mBAAA,EAAA,GACR,MADQ,CACD,QADC,CAAA"}

package/dist/index.d.mts

@@ -0,0 +1,21 @@
+import { SatoriPluginContext, SatoriPluginOptions, SatoriPluginResolvedConfig, SatoriPluginUserConfig, __ΩSatoriPluginContext, __ΩSatoriPluginOptions, __ΩSatoriPluginResolvedConfig, __ΩSatoriPluginUserConfig } from "./types/plugin.mjs";
+import { SatoriComponentModule, __ΩSatoriComponentModule } from "./types/module.mjs";
+import "./types/index.mjs";
+import { Plugin } from "powerlines";
+
+//#region src/index.d.ts
+declare module "powerlines" {
+  interface Config {
+    satori?: SatoriPluginOptions;
+  }
+}
+/**
+ * A Powerlines plugin to use Untyped for code generation based on user-defined schemas.
+ *
+ * @param options - The plugin options.
+ * @returns A Powerlines plugin instance.
+ */
+declare const plugin: <TContext extends SatoriPluginContext = SatoriPluginContext>(options: SatoriPluginOptions) => Plugin<TContext>;
+//#endregion
+export { SatoriComponentModule, SatoriPluginContext, SatoriPluginOptions, SatoriPluginResolvedConfig, SatoriPluginUserConfig, __ΩSatoriComponentModule, __ΩSatoriPluginContext, __ΩSatoriPluginOptions, __ΩSatoriPluginResolvedConfig, __ΩSatoriPluginUserConfig, plugin as default, plugin };
+//# sourceMappingURL=index.d.mts.map

package/dist/index.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.mts","names":[],"sources":["../src/index.ts"],"sourcesContent":[],"mappings":";;;;;;;;aAuCa;EAJW;;;;;AAcxB;;;AAGW,cAHE,MAGF,EAAA,CAAA,iBAFQ,mBAER,GAF8B,mBAE9B,CAAA,CAAA,OAAA,EAAA,mBAAA,EAAA,GACR,MADQ,CACD,QADC,CAAA"}

package/dist/index.mjs

@@ -52,4 +52,5 @@ const plugin = (options) => {
 var src_default = plugin;
 
 //#endregion
-export { src_default as default, plugin };
+export { src_default as default, plugin };
+//# sourceMappingURL=index.mjs.map

package/dist/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.mjs","names":[],"sources":["../src/index.ts"],"sourcesContent":["/* -------------------------------------------------------------------\n\n                   ⚡ Storm Software - Powerlines\n\n This code was released as part of the Powerlines project. Powerlines\n is maintained by Storm Software under the Apache-2.0 license, and is\n free for commercial and private use. For more information, please visit\n our licensing page at https://stormsoftware.com/licenses/projects/powerlines.\n\n Website:                  https://stormsoftware.com\n Repository:               https://github.com/storm-software/powerlines\n Documentation:            https://docs.stormsoftware.com/projects/powerlines\n Contact:                  https://stormsoftware.com/contact\n\n SPDX-License-Identifier:  Apache-2.0\n\n ------------------------------------------------------------------- */\n\nimport { toArray } from \"@stryke/convert/to-array\";\nimport { existsSync } from \"@stryke/fs/exists\";\nimport { listFiles } from \"@stryke/fs/list-files\";\nimport { findFileExtensionSafe } from \"@stryke/path/file-path-fns\";\nimport { joinPaths } from \"@stryke/path/join-paths\";\nimport { replacePath } from \"@stryke/path/replace\";\nimport defu from \"defu\";\nimport type { Plugin } from \"powerlines\";\nimport { replacePathTokens } from \"powerlines/plugin-utils\";\nimport satori from \"satori\";\nimport { SatoriComponentModule } from \"./types/module\";\nimport {\n  SatoriPluginContext,\n  SatoriPluginOptions,\n  SatoriPluginUserConfig\n} from \"./types/plugin\";\n\nexport * from \"./types\";\n\ndeclare module \"powerlines\" {\n  interface Config {\n    satori?: SatoriPluginOptions;\n  }\n}\n\n/**\n * A Powerlines plugin to use Untyped for code generation based on user-defined schemas.\n *\n * @param options - The plugin options.\n * @returns A Powerlines plugin instance.\n */\nexport const plugin = <\n  TContext extends SatoriPluginContext = SatoriPluginContext\n>(\n  options: SatoriPluginOptions\n): Plugin<TContext> => {\n  return {\n    name: \"satori\",\n    config() {\n      return {\n        satori: {\n          defaultOptions: {},\n          width: 1200,\n          height: 630,\n          fonts: [],\n          ...options\n        }\n      } as Partial<SatoriPluginUserConfig>;\n    },\n    async configResolved() {\n      if (!this.config.satori.path) {\n        throw new Error(\n          \"The Powerlines Satori plugin requires a \\`path\\` option to be specified.\"\n        );\n      }\n\n      this.config.satori.inputs = (\n        await Promise.all(\n          toArray(this.config.satori.path).map(async path => {\n            if (path.includes(\"*\")) {\n              return listFiles(replacePathTokens(this, path));\n            }\n\n            return replacePathTokens(this, path);\n          })\n        )\n      )\n        .flat()\n        .filter(\n          path =>\n            path &&\n            [\"jsx\", \"tsx\"].includes(findFileExtensionSafe(path)) &&\n            existsSync(path)\n        );\n    },\n    async prepare() {\n      await Promise.all(\n        this.config.satori.inputs.map(async input => {\n          try {\n            const mod =\n              await this.resolver.import<SatoriComponentModule>(input);\n            if (mod && mod.default) {\n              const result = await satori(\n                mod.default,\n                defu(mod.options ?? {}, this.config.satori.defaultOptions)\n              );\n              if (result) {\n                await this.fs.write(\n                  this.config.satori.outputPath\n                    ? joinPaths(\n                        this.config.satori.outputPath,\n                        replacePath(\n                          input,\n                          joinPaths(\n                            this.workspaceConfig.workspaceRoot,\n                            this.config.root\n                          )\n                        )\n                      )\n                    : input.replace(findFileExtensionSafe(input), \"svg\"),\n                  result\n                );\n              }\n            }\n          } catch (error) {\n            this.debug(\n              `Failed to load Satori schema from ${input}: ${(error as Error).message}`\n            );\n          }\n        })\n      );\n    }\n  };\n};\n\nexport default plugin;\n"],"mappings":";;;;;;;;;;;;;;;;;AAiDA,MAAa,UAGX,YACqB;AACrB,QAAO;EACL,MAAM;EACN,SAAS;AACP,UAAO,EACL,QAAQ;IACN,gBAAgB,EAAE;IAClB,OAAO;IACP,QAAQ;IACR,OAAO,EAAE;IACT,GAAG;IACJ,EACF;;EAEH,MAAM,iBAAiB;AACrB,OAAI,CAAC,KAAK,OAAO,OAAO,KACtB,OAAM,IAAI,MACR,yEACD;AAGH,QAAK,OAAO,OAAO,UACjB,MAAM,QAAQ,IACZ,QAAQ,KAAK,OAAO,OAAO,KAAK,CAAC,IAAI,OAAM,SAAQ;AACjD,QAAI,KAAK,SAAS,IAAI,CACpB,QAAO,UAAU,kBAAkB,MAAM,KAAK,CAAC;AAGjD,WAAO,kBAAkB,MAAM,KAAK;KACpC,CACH,EAEA,MAAM,CACN,QACC,SACE,QACA,CAAC,OAAO,MAAM,CAAC,SAAS,sBAAsB,KAAK,CAAC,IACpD,WAAW,KAAK,CACnB;;EAEL,MAAM,UAAU;AACd,SAAM,QAAQ,IACZ,KAAK,OAAO,OAAO,OAAO,IAAI,OAAM,UAAS;AAC3C,QAAI;KACF,MAAM,MACJ,MAAM,KAAK,SAAS,OAA8B,MAAM;AAC1D,SAAI,OAAO,IAAI,SAAS;MACtB,MAAM,SAAS,MAAM,OACnB,IAAI,SACJ,KAAK,IAAI,WAAW,EAAE,EAAE,KAAK,OAAO,OAAO,eAAe,CAC3D;AACD,UAAI,OACF,OAAM,KAAK,GAAG,MACZ,KAAK,OAAO,OAAO,aACf,UACE,KAAK,OAAO,OAAO,YACnB,YACE,OACA,UACE,KAAK,gBAAgB,eACrB,KAAK,OAAO,KACb,CACF,CACF,GACD,MAAM,QAAQ,sBAAsB,MAAM,EAAE,MAAM,EACtD,OACD;;aAGE,OAAO;AACd,UAAK,MACH,qCAAqC,MAAM,IAAK,MAAgB,UACjE;;KAEH,CACH;;EAEJ;;AAGH,kBAAe"}

package/dist/types/index.d.cts

@@ -0,0 +1,3 @@
+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

@@ -0,0 +1,3 @@
+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/module.d.cts

@@ -0,0 +1,12 @@
+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 };
+//# sourceMappingURL=module.d.cts.map

package/dist/types/module.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"module.d.cts","names":[],"sources":["../../src/types/module.ts"],"sourcesContent":[],"mappings":";;;;UAqBiB,qBAAA;WACN;EADM,OAAA,CAAA,EAEL,aAFK"}

package/dist/types/module.d.mts

@@ -0,0 +1,12 @@
+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 };
+//# sourceMappingURL=module.d.mts.map

package/dist/types/module.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"module.d.mts","names":[],"sources":["../../src/types/module.ts"],"sourcesContent":[],"mappings":";;;;UAqBiB,qBAAA;WACN;EADM,OAAA,CAAA,EAEL,aAFK"}

package/dist/types/plugin.d.cts

@@ -0,0 +1,46 @@
+import { PluginContext, ResolvedConfig, UserConfig } from "powerlines";
+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 };
+//# sourceMappingURL=plugin.d.cts.map

package/dist/types/plugin.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"plugin.d.cts","names":[],"sources":["../../src/types/plugin.ts"],"sourcesContent":[],"mappings":";;;;UAqBiB,mBAAA;;AAAjB;AAuBA;EACgB,IAAA,EAAA,MAAA,GAAA,MAAA,EAAA;EAAL;;;;;;EAIM,UAAA,CAAA,EAAA,MAAA;EACF;;;;;;EADmD,cAAA,CAAA,EAR/C,OAQ+C,CARvC,aAQuC,CAAA;AAalE;AAC0B,UAnBT,sBAAA,SAA+B,UAmBtB,CAAA;EACtB,MAAA,CAAA,EAnBO,IAmBP,CAnBY,mBAmBZ,EAAA,gBAAA,CAAA,GAlBA,QAkBA,CAlBS,IAkBT,CAlBc,mBAkBd,EAAA,gBAAA,CAAA,CAAA;;AACA,UAhBa,0BAAA,SAAmC,cAgBhD,CAAA;EAAa,MAAA,EAfP,IAeO,CAfF,mBAeE,EAAA,gBAAA,CAAA,GAdb,QAca,CAdJ,IAcI,CAdC,mBAcD,EAAA,gBAAA,CAAA,CAAA,GAAA;;;;;;;;;;KAHL,4CACc,6BACtB,8BACA,cAAc"}

package/dist/types/plugin.d.mts

@@ -0,0 +1,46 @@
+import { SatoriOptions } from "satori";
+import { PluginContext, ResolvedConfig, UserConfig } from "powerlines";
+
+//#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 };
+//# sourceMappingURL=plugin.d.mts.map

package/dist/types/plugin.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"plugin.d.mts","names":[],"sources":["../../src/types/plugin.ts"],"sourcesContent":[],"mappings":";;;;UAqBiB,mBAAA;;AAAjB;AAuBA;EACgB,IAAA,EAAA,MAAA,GAAA,MAAA,EAAA;EAAL;;;;;;EAIM,UAAA,CAAA,EAAA,MAAA;EACF;;;;;;EADmD,cAAA,CAAA,EAR/C,OAQ+C,CARvC,aAQuC,CAAA;AAalE;AAC0B,UAnBT,sBAAA,SAA+B,UAmBtB,CAAA;EACtB,MAAA,CAAA,EAnBO,IAmBP,CAnBY,mBAmBZ,EAAA,gBAAA,CAAA,GAlBA,QAkBA,CAlBS,IAkBT,CAlBc,mBAkBd,EAAA,gBAAA,CAAA,CAAA;;AACA,UAhBa,0BAAA,SAAmC,cAgBhD,CAAA;EAAa,MAAA,EAfP,IAeO,CAfF,mBAeE,EAAA,gBAAA,CAAA,GAdb,QAca,CAdJ,IAcI,CAdC,mBAcD,EAAA,gBAAA,CAAA,CAAA,GAAA;;;;;;;;;;KAHL,4CACc,6BACtB,8BACA,cAAc"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@powerlines/plugin-satori",
-  "version": "0.1.337",
+  "version": "0.1.339",
   "type": "module",
   "description": "A Powerlines plugin to use Satori to generate SVG files from jsx/tsx components.",
   "repository": {
@@ -117,11 +117,11 @@
     "@stryke/types": "^0.10.52",
     "defu": "^6.1.4",
     "jiti": "^2.6.1",
-    "powerlines": "^0.41.3",
+    "powerlines": "^0.41.5",
     "satori": "^0.18.4"
   },
   "devDependencies": {
-    "@powerlines/plugin-plugin": "^0.12.289",
+    "@powerlines/plugin-plugin": "^0.12.291",
     "@storm-software/config": "^1.135.29",
     "@types/node": "^25.4.0",
     "@types/react": "^19.2.14",
@@ -129,5 +129,5 @@
   },
   "publishConfig": { "access": "public" },
   "types": "./dist/index.d.cts",
-  "gitHead": "df3c5d736cd0fce20967864a4920af034e9434e3"
+  "gitHead": "0ed0ad0cd6f440d1584ac705987ef985931161db"
 }