@powerlines/plugin-satori 0.1.115 → 0.1.117

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1 +1,29 @@
1
- var e=Object.create,t=Object.defineProperty,n=Object.getOwnPropertyDescriptor,r=Object.getOwnPropertyNames,i=Object.getPrototypeOf,a=Object.prototype.hasOwnProperty,o=(e,i,o,s)=>{if(i&&typeof i==`object`||typeof i==`function`)for(var c=r(i),l=0,u=c.length,d;l<u;l++)d=c[l],!a.call(e,d)&&d!==o&&t(e,d,{get:(e=>i[e]).bind(null,d),enumerable:!(s=n(i,d))||s.enumerable});return e},s=(n,r,a)=>(a=n==null?{}:e(i(n)),o(r||!n||!n.__esModule?t(a,`default`,{value:n,enumerable:!0}):a,n));exports.__toESM=s;
1
+ //#region rolldown:runtime
2
+ var __create = Object.create;
3
+ var __defProp = Object.defineProperty;
4
+ var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
5
+ var __getOwnPropNames = Object.getOwnPropertyNames;
6
+ var __getProtoOf = Object.getPrototypeOf;
7
+ var __hasOwnProp = Object.prototype.hasOwnProperty;
8
+ var __copyProps = (to, from, except, desc) => {
9
+ if (from && typeof from === "object" || typeof from === "function") {
10
+ for (var keys = __getOwnPropNames(from), i = 0, n = keys.length, key; i < n; i++) {
11
+ key = keys[i];
12
+ if (!__hasOwnProp.call(to, key) && key !== except) {
13
+ __defProp(to, key, {
14
+ get: ((k) => from[k]).bind(null, key),
15
+ enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable
16
+ });
17
+ }
18
+ }
19
+ }
20
+ return to;
21
+ };
22
+ var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", {
23
+ value: mod,
24
+ enumerable: true
25
+ }) : target, mod));
26
+
27
+ //#endregion
28
+
29
+ exports.__toESM = __toESM;
package/dist/index.cjs CHANGED
@@ -1 +1,61 @@
1
- Object.defineProperty(exports,`__esModule`,{value:!0});const e=require(`./_virtual/rolldown_runtime.cjs`),t=require(`./powerlines/src/plugin-utils/paths.cjs`);let n=require(`@storm-software/config-tools/types`),r=require(`@stryke/convert/to-array`),i=require(`@stryke/fs/exists`),a=require(`@stryke/fs/list-files`),o=require(`@stryke/path/file-path-fns`),s=require(`@stryke/path/join-paths`),c=require(`@stryke/path/replace`),l=require(`defu`);l=e.__toESM(l);let u=require(`satori`);u=e.__toESM(u);const d=e=>({name:`satori`,config(){return{satori:{defaultOptions:{},width:1200,height:630,fonts:[],...e}}},async configResolved(){if(!this.config.satori.path)throw Error("The Powerlines Satori plugin requires a `path` option to be specified.");this.config.satori.inputs=(await Promise.all((0,r.toArray)(this.config.satori.path).map(async e=>e.includes(`*`)?(0,a.listFiles)(t.replacePathTokens(this,e)):t.replacePathTokens(this,e)))).flat().filter(e=>e&&[`jsx`,`tsx`].includes((0,o.findFileExtensionSafe)(e))&&(0,i.existsSync)(e))},async prepare(){await Promise.all(this.config.satori.inputs.map(async e=>{try{let t=await this.resolver.import(e);if(t&&t.default){let n=await(0,u.default)(t.default,(0,l.default)(t.options??{},this.config.satori.defaultOptions));n&&await this.fs.write(this.config.satori.outputPath?(0,s.joinPaths)(this.config.satori.outputPath,(0,c.replacePath)(e,(0,s.joinPaths)(this.workspaceConfig.workspaceRoot,this.config.projectRoot))):e.replace((0,o.findFileExtensionSafe)(e),`svg`),n)}}catch(t){this.log(n.LogLevelLabel.DEBUG,`Failed to load Satori schema from ${e}: ${t.message}`)}}))}});var f=d;exports.default=f,exports.plugin=d;
1
+ Object.defineProperty(exports, '__esModule', { value: true });
2
+ const require_rolldown_runtime = require('./_virtual/rolldown_runtime.cjs');
3
+ const require_paths = require('./powerlines/src/plugin-utils/paths.cjs');
4
+ let __storm_software_config_tools_types = require("@storm-software/config-tools/types");
5
+ let __stryke_convert_to_array = require("@stryke/convert/to-array");
6
+ let __stryke_fs_exists = require("@stryke/fs/exists");
7
+ let __stryke_fs_list_files = require("@stryke/fs/list-files");
8
+ let __stryke_path_file_path_fns = require("@stryke/path/file-path-fns");
9
+ let __stryke_path_join_paths = require("@stryke/path/join-paths");
10
+ let __stryke_path_replace = require("@stryke/path/replace");
11
+ let defu = require("defu");
12
+ defu = require_rolldown_runtime.__toESM(defu);
13
+ let satori = require("satori");
14
+ satori = require_rolldown_runtime.__toESM(satori);
15
+
16
+ //#region src/index.ts
17
+ /**
18
+ * A Powerlines plugin to use Untyped for code generation based on user-defined schemas.
19
+ *
20
+ * @param options - The plugin options.
21
+ * @returns A Powerlines plugin instance.
22
+ */
23
+ const plugin = (options) => {
24
+ return {
25
+ name: "satori",
26
+ config() {
27
+ return { satori: {
28
+ defaultOptions: {},
29
+ width: 1200,
30
+ height: 630,
31
+ fonts: [],
32
+ ...options
33
+ } };
34
+ },
35
+ async configResolved() {
36
+ if (!this.config.satori.path) throw new Error("The Powerlines Satori plugin requires a `path` option to be specified.");
37
+ this.config.satori.inputs = (await Promise.all((0, __stryke_convert_to_array.toArray)(this.config.satori.path).map(async (path) => {
38
+ if (path.includes("*")) return (0, __stryke_fs_list_files.listFiles)(require_paths.replacePathTokens(this, path));
39
+ return require_paths.replacePathTokens(this, path);
40
+ }))).flat().filter((path) => path && ["jsx", "tsx"].includes((0, __stryke_path_file_path_fns.findFileExtensionSafe)(path)) && (0, __stryke_fs_exists.existsSync)(path));
41
+ },
42
+ async prepare() {
43
+ await Promise.all(this.config.satori.inputs.map(async (input) => {
44
+ try {
45
+ const mod = await this.resolver.import(input);
46
+ if (mod && mod.default) {
47
+ const result = await (0, satori.default)(mod.default, (0, defu.default)(mod.options ?? {}, this.config.satori.defaultOptions));
48
+ if (result) await this.fs.write(this.config.satori.outputPath ? (0, __stryke_path_join_paths.joinPaths)(this.config.satori.outputPath, (0, __stryke_path_replace.replacePath)(input, (0, __stryke_path_join_paths.joinPaths)(this.workspaceConfig.workspaceRoot, this.config.projectRoot))) : input.replace((0, __stryke_path_file_path_fns.findFileExtensionSafe)(input), "svg"), result);
49
+ }
50
+ } catch (error) {
51
+ this.log(__storm_software_config_tools_types.LogLevelLabel.DEBUG, `Failed to load Satori schema from ${input}: ${error.message}`);
52
+ }
53
+ }));
54
+ }
55
+ };
56
+ };
57
+ var src_default = plugin;
58
+
59
+ //#endregion
60
+ exports.default = src_default;
61
+ exports.plugin = plugin;
package/dist/index.mjs CHANGED
@@ -1 +1,56 @@
1
- import{replacePathTokens as e}from"./powerlines/src/plugin-utils/paths.mjs";import{LogLevelLabel as t}from"@storm-software/config-tools/types";import{toArray as n}from"@stryke/convert/to-array";import{existsSync as r}from"@stryke/fs/exists";import{listFiles as i}from"@stryke/fs/list-files";import{findFileExtensionSafe as a}from"@stryke/path/file-path-fns";import{joinPaths as o}from"@stryke/path/join-paths";import{replacePath as s}from"@stryke/path/replace";import c from"defu";import l from"satori";const u=u=>({name:`satori`,config(){return{satori:{defaultOptions:{},width:1200,height:630,fonts:[],...u}}},async configResolved(){if(!this.config.satori.path)throw Error("The Powerlines Satori plugin requires a `path` option to be specified.");this.config.satori.inputs=(await Promise.all(n(this.config.satori.path).map(async t=>t.includes(`*`)?i(e(this,t)):e(this,t)))).flat().filter(e=>e&&[`jsx`,`tsx`].includes(a(e))&&r(e))},async prepare(){await Promise.all(this.config.satori.inputs.map(async e=>{try{let t=await this.resolver.import(e);if(t&&t.default){let n=await l(t.default,c(t.options??{},this.config.satori.defaultOptions));n&&await this.fs.write(this.config.satori.outputPath?o(this.config.satori.outputPath,s(e,o(this.workspaceConfig.workspaceRoot,this.config.projectRoot))):e.replace(a(e),`svg`),n)}}catch(n){this.log(t.DEBUG,`Failed to load Satori schema from ${e}: ${n.message}`)}}))}});var d=u;export{d as default,u as plugin};
1
+ import { replacePathTokens } from "./powerlines/src/plugin-utils/paths.mjs";
2
+ import { LogLevelLabel } from "@storm-software/config-tools/types";
3
+ import { toArray } from "@stryke/convert/to-array";
4
+ import { existsSync } from "@stryke/fs/exists";
5
+ import { listFiles } from "@stryke/fs/list-files";
6
+ import { findFileExtensionSafe } from "@stryke/path/file-path-fns";
7
+ import { joinPaths } from "@stryke/path/join-paths";
8
+ import { replacePath } from "@stryke/path/replace";
9
+ import defu from "defu";
10
+ import satori from "satori";
11
+
12
+ //#region src/index.ts
13
+ /**
14
+ * A Powerlines plugin to use Untyped for code generation based on user-defined schemas.
15
+ *
16
+ * @param options - The plugin options.
17
+ * @returns A Powerlines plugin instance.
18
+ */
19
+ const plugin = (options) => {
20
+ return {
21
+ name: "satori",
22
+ config() {
23
+ return { satori: {
24
+ defaultOptions: {},
25
+ width: 1200,
26
+ height: 630,
27
+ fonts: [],
28
+ ...options
29
+ } };
30
+ },
31
+ async configResolved() {
32
+ if (!this.config.satori.path) throw new Error("The Powerlines Satori plugin requires a `path` option to be specified.");
33
+ this.config.satori.inputs = (await Promise.all(toArray(this.config.satori.path).map(async (path) => {
34
+ if (path.includes("*")) return listFiles(replacePathTokens(this, path));
35
+ return replacePathTokens(this, path);
36
+ }))).flat().filter((path) => path && ["jsx", "tsx"].includes(findFileExtensionSafe(path)) && existsSync(path));
37
+ },
38
+ async prepare() {
39
+ await Promise.all(this.config.satori.inputs.map(async (input) => {
40
+ try {
41
+ const mod = await this.resolver.import(input);
42
+ if (mod && mod.default) {
43
+ const result = await satori(mod.default, defu(mod.options ?? {}, this.config.satori.defaultOptions));
44
+ if (result) await this.fs.write(this.config.satori.outputPath ? joinPaths(this.config.satori.outputPath, replacePath(input, joinPaths(this.workspaceConfig.workspaceRoot, this.config.projectRoot))) : input.replace(findFileExtensionSafe(input), "svg"), result);
45
+ }
46
+ } catch (error) {
47
+ this.log(LogLevelLabel.DEBUG, `Failed to load Satori schema from ${input}: ${error.message}`);
48
+ }
49
+ }));
50
+ }
51
+ };
52
+ };
53
+ var src_default = plugin;
54
+
55
+ //#endregion
56
+ export { src_default as default, plugin };
@@ -1 +1,36 @@
1
- const e=require(`../../../_virtual/rolldown_runtime.cjs`);let t=require(`@stryke/path/replace`);function n(e,n){return n&&n.replaceAll(`{workspaceRoot}`,e.workspaceConfig.workspaceRoot).replaceAll(`{root}`,e.config.projectRoot).replaceAll(`{projectRoot}`,e.config.projectRoot).replaceAll(`{sourceRoot}`,e.config.sourceRoot).replaceAll(`{powerlinesPath}`,e.powerlinesPath).replaceAll(`{cachePath}`,e.cachePath).replaceAll(`{dataPath}`,e.dataPath).replaceAll(`{logPath}`,e.envPaths.log).replaceAll(`{tempPath}`,e.envPaths.temp).replaceAll(`{configPath}`,e.envPaths.config).replaceAll(`{outputPath}`,e.config.output.outputPath).replaceAll(`{buildPath}`,e.config.output.buildPath).replaceAll(`{artifactsPath}`,(0,t.replacePath)(e.artifactsPath,e.workspaceConfig.workspaceRoot)).replaceAll(`{builtinPath}`,(0,t.replacePath)(e.builtinsPath,e.workspaceConfig.workspaceRoot)).replaceAll(`{entryPath}`,(0,t.replacePath)(e.entryPath,e.workspaceConfig.workspaceRoot))}exports.replacePathTokens=n;
1
+ const require_rolldown_runtime = require('../../../_virtual/rolldown_runtime.cjs');
2
+ let __stryke_path_replace = require("@stryke/path/replace");
3
+
4
+ //#region ../powerlines/src/plugin-utils/paths.ts
5
+ /**
6
+ * Replaces tokens in the given path string with their corresponding values from the context.
7
+ *
8
+ * @remarks
9
+ * The following tokens are supported:
10
+ * - `{workspaceRoot}` - The root directory of the workspace.
11
+ * - `{root}` - The root directory of the project (same as `{projectRoot}`).
12
+ * - `{projectRoot}` - The root directory of the project (same as `{root}`).
13
+ * - `{sourceRoot}` - The source root directory of the project (usually `./src`).
14
+ * - `{powerlinesPath}` - The directory where Powerlines is installed.
15
+ * - `{cachePath}` - The environment's directory for cached files.
16
+ * - `{dataPath}` - The environment's directory for data files.
17
+ * - `{logPath}` - The environment's directory for log files.
18
+ * - `{tempPath}` - The environment's directory for temporary files.
19
+ * - `{configPath}` - The environment's directory for configuration files.
20
+ * - `{outputPath}` - The configured output directory for the project.
21
+ * - `{buildPath}` - The configured distribution directory for the project.
22
+ * - `{artifactsPath}` - The configured directory for build artifacts.
23
+ * - `{builtinPath}` - The configured directory for generated built-in plugins.
24
+ * - `{entryPath}` - The configured directory for generated entry files.
25
+ *
26
+ * @param context - The context containing the values for the path tokens.
27
+ * @param path - The path string with tokens to replace.
28
+ * @returns The path string with tokens replaced by their corresponding values from the context.
29
+ */
30
+ function replacePathTokens(context, path) {
31
+ if (!path) return path;
32
+ return path.replaceAll("{workspaceRoot}", context.workspaceConfig.workspaceRoot).replaceAll("{root}", context.config.projectRoot).replaceAll("{projectRoot}", context.config.projectRoot).replaceAll("{sourceRoot}", context.config.sourceRoot).replaceAll("{powerlinesPath}", context.powerlinesPath).replaceAll("{cachePath}", context.cachePath).replaceAll("{dataPath}", context.dataPath).replaceAll("{logPath}", context.envPaths.log).replaceAll("{tempPath}", context.envPaths.temp).replaceAll("{configPath}", context.envPaths.config).replaceAll("{outputPath}", context.config.output.outputPath).replaceAll("{buildPath}", context.config.output.buildPath).replaceAll("{artifactsPath}", (0, __stryke_path_replace.replacePath)(context.artifactsPath, context.workspaceConfig.workspaceRoot)).replaceAll("{builtinPath}", (0, __stryke_path_replace.replacePath)(context.builtinsPath, context.workspaceConfig.workspaceRoot)).replaceAll("{entryPath}", (0, __stryke_path_replace.replacePath)(context.entryPath, context.workspaceConfig.workspaceRoot));
33
+ }
34
+
35
+ //#endregion
36
+ exports.replacePathTokens = replacePathTokens;
@@ -1 +1,35 @@
1
- import{replacePath as e}from"@stryke/path/replace";function t(t,n){return n&&n.replaceAll(`{workspaceRoot}`,t.workspaceConfig.workspaceRoot).replaceAll(`{root}`,t.config.projectRoot).replaceAll(`{projectRoot}`,t.config.projectRoot).replaceAll(`{sourceRoot}`,t.config.sourceRoot).replaceAll(`{powerlinesPath}`,t.powerlinesPath).replaceAll(`{cachePath}`,t.cachePath).replaceAll(`{dataPath}`,t.dataPath).replaceAll(`{logPath}`,t.envPaths.log).replaceAll(`{tempPath}`,t.envPaths.temp).replaceAll(`{configPath}`,t.envPaths.config).replaceAll(`{outputPath}`,t.config.output.outputPath).replaceAll(`{buildPath}`,t.config.output.buildPath).replaceAll(`{artifactsPath}`,e(t.artifactsPath,t.workspaceConfig.workspaceRoot)).replaceAll(`{builtinPath}`,e(t.builtinsPath,t.workspaceConfig.workspaceRoot)).replaceAll(`{entryPath}`,e(t.entryPath,t.workspaceConfig.workspaceRoot))}export{t as replacePathTokens};
1
+ import { replacePath } from "@stryke/path/replace";
2
+
3
+ //#region ../powerlines/src/plugin-utils/paths.ts
4
+ /**
5
+ * Replaces tokens in the given path string with their corresponding values from the context.
6
+ *
7
+ * @remarks
8
+ * The following tokens are supported:
9
+ * - `{workspaceRoot}` - The root directory of the workspace.
10
+ * - `{root}` - The root directory of the project (same as `{projectRoot}`).
11
+ * - `{projectRoot}` - The root directory of the project (same as `{root}`).
12
+ * - `{sourceRoot}` - The source root directory of the project (usually `./src`).
13
+ * - `{powerlinesPath}` - The directory where Powerlines is installed.
14
+ * - `{cachePath}` - The environment's directory for cached files.
15
+ * - `{dataPath}` - The environment's directory for data files.
16
+ * - `{logPath}` - The environment's directory for log files.
17
+ * - `{tempPath}` - The environment's directory for temporary files.
18
+ * - `{configPath}` - The environment's directory for configuration files.
19
+ * - `{outputPath}` - The configured output directory for the project.
20
+ * - `{buildPath}` - The configured distribution directory for the project.
21
+ * - `{artifactsPath}` - The configured directory for build artifacts.
22
+ * - `{builtinPath}` - The configured directory for generated built-in plugins.
23
+ * - `{entryPath}` - The configured directory for generated entry files.
24
+ *
25
+ * @param context - The context containing the values for the path tokens.
26
+ * @param path - The path string with tokens to replace.
27
+ * @returns The path string with tokens replaced by their corresponding values from the context.
28
+ */
29
+ function replacePathTokens(context, path) {
30
+ if (!path) return path;
31
+ return path.replaceAll("{workspaceRoot}", context.workspaceConfig.workspaceRoot).replaceAll("{root}", context.config.projectRoot).replaceAll("{projectRoot}", context.config.projectRoot).replaceAll("{sourceRoot}", context.config.sourceRoot).replaceAll("{powerlinesPath}", context.powerlinesPath).replaceAll("{cachePath}", context.cachePath).replaceAll("{dataPath}", context.dataPath).replaceAll("{logPath}", context.envPaths.log).replaceAll("{tempPath}", context.envPaths.temp).replaceAll("{configPath}", context.envPaths.config).replaceAll("{outputPath}", context.config.output.outputPath).replaceAll("{buildPath}", context.config.output.buildPath).replaceAll("{artifactsPath}", replacePath(context.artifactsPath, context.workspaceConfig.workspaceRoot)).replaceAll("{builtinPath}", replacePath(context.builtinsPath, context.workspaceConfig.workspaceRoot)).replaceAll("{entryPath}", replacePath(context.entryPath, context.workspaceConfig.workspaceRoot));
32
+ }
33
+
34
+ //#endregion
35
+ export { replacePathTokens };
@@ -78,10 +78,18 @@ interface ParseOptions extends ParserOptions {
78
78
  */
79
79
  allowReturnOutsideFunction?: boolean;
80
80
  }
81
+ interface EmitOptions extends WriteOptions {
82
+ /**
83
+ * If true, will emit the file using {@link UnpluginBuildContext.emitFile | the bundler's emit function}.
84
+ */
85
+ emitWithBundler?: boolean;
86
+ needsCodeReference?: Parameters<UnpluginBuildContext["emitFile"]>[0]["needsCodeReference"];
87
+ originalFileName?: Parameters<UnpluginBuildContext["emitFile"]>[0]["originalFileName"];
88
+ }
81
89
  /**
82
90
  * Options for emitting entry virtual files
83
91
  */
84
- type EmitEntryOptions = WriteOptions & Omit<ResolvedEntryTypeDefinition, "file">;
92
+ type EmitEntryOptions = EmitOptions & Omit<ResolvedEntryTypeDefinition, "file">;
85
93
  /**
86
94
  * The unresolved Powerlines context.
87
95
  *
@@ -292,6 +300,22 @@ interface UnresolvedContext<TResolvedConfig extends ResolvedConfig = ResolvedCon
292
300
  * The Powerlines builtin virtual files
293
301
  */
294
302
  getBuiltins: () => Promise<VirtualFile[]>;
303
+ /**
304
+ * Resolves a file and writes it to the VFS if it does not already exist
305
+ *
306
+ * @param code - The source code of the file
307
+ * @param path - The path to write the file to
308
+ * @param options - Additional options for writing the file
309
+ */
310
+ emit: (code: string, path: string, options?: EmitOptions) => Promise<void>;
311
+ /**
312
+ * Synchronously resolves a file and writes it to the VFS if it does not already exist
313
+ *
314
+ * @param code - The source code of the file
315
+ * @param path - The path to write the file to
316
+ * @param options - Additional options for writing the file
317
+ */
318
+ emitSync: (code: string, path: string, options?: EmitOptions) => void;
295
319
  /**
296
320
  * Resolves a builtin virtual file and writes it to the VFS if it does not already exist
297
321
  *
@@ -300,7 +324,16 @@ interface UnresolvedContext<TResolvedConfig extends ResolvedConfig = ResolvedCon
300
324
  * @param path - An optional path to write the builtin file to
301
325
  * @param options - Additional options for writing the builtin file
302
326
  */
303
- emitBuiltin: (code: string, id: string, path?: string, options?: WriteOptions) => Promise<void>;
327
+ emitBuiltin: (code: string, id: string, path?: string, options?: EmitOptions) => Promise<void>;
328
+ /**
329
+ * Synchronously resolves a builtin virtual file and writes it to the VFS if it does not already exist
330
+ *
331
+ * @param code - The source code of the builtin file
332
+ * @param id - The unique identifier of the builtin file
333
+ * @param path - An optional path to write the builtin file to
334
+ * @param options - Additional options for writing the builtin file
335
+ */
336
+ emitBuiltinSync: (code: string, id: string, path?: string, options?: EmitOptions) => void;
304
337
  /**
305
338
  * Resolves a entry virtual file and writes it to the VFS if it does not already exist
306
339
  *
@@ -309,6 +342,14 @@ interface UnresolvedContext<TResolvedConfig extends ResolvedConfig = ResolvedCon
309
342
  * @param options - Additional options for writing the entry file
310
343
  */
311
344
  emitEntry: (code: string, path: string, options?: EmitEntryOptions) => Promise<void>;
345
+ /**
346
+ * Synchronously resolves a entry virtual file and writes it to the VFS if it does not already exist
347
+ *
348
+ * @param code - The source code of the entry file
349
+ * @param path - An optional path to write the entry file to
350
+ * @param options - Additional options for writing the entry file
351
+ */
352
+ emitEntrySync: (code: string, path: string, options?: EmitEntryOptions) => void;
312
353
  /**
313
354
  * A function to update the context fields using a new user configuration options
314
355
  */
@@ -80,10 +80,18 @@ interface ParseOptions extends ParserOptions {
80
80
  */
81
81
  allowReturnOutsideFunction?: boolean;
82
82
  }
83
+ interface EmitOptions extends WriteOptions {
84
+ /**
85
+ * If true, will emit the file using {@link UnpluginBuildContext.emitFile | the bundler's emit function}.
86
+ */
87
+ emitWithBundler?: boolean;
88
+ needsCodeReference?: Parameters<UnpluginBuildContext["emitFile"]>[0]["needsCodeReference"];
89
+ originalFileName?: Parameters<UnpluginBuildContext["emitFile"]>[0]["originalFileName"];
90
+ }
83
91
  /**
84
92
  * Options for emitting entry virtual files
85
93
  */
86
- type EmitEntryOptions = WriteOptions & Omit<ResolvedEntryTypeDefinition, "file">;
94
+ type EmitEntryOptions = EmitOptions & Omit<ResolvedEntryTypeDefinition, "file">;
87
95
  /**
88
96
  * The unresolved Powerlines context.
89
97
  *
@@ -294,6 +302,22 @@ interface UnresolvedContext<TResolvedConfig extends ResolvedConfig = ResolvedCon
294
302
  * The Powerlines builtin virtual files
295
303
  */
296
304
  getBuiltins: () => Promise<VirtualFile[]>;
305
+ /**
306
+ * Resolves a file and writes it to the VFS if it does not already exist
307
+ *
308
+ * @param code - The source code of the file
309
+ * @param path - The path to write the file to
310
+ * @param options - Additional options for writing the file
311
+ */
312
+ emit: (code: string, path: string, options?: EmitOptions) => Promise<void>;
313
+ /**
314
+ * Synchronously resolves a file and writes it to the VFS if it does not already exist
315
+ *
316
+ * @param code - The source code of the file
317
+ * @param path - The path to write the file to
318
+ * @param options - Additional options for writing the file
319
+ */
320
+ emitSync: (code: string, path: string, options?: EmitOptions) => void;
297
321
  /**
298
322
  * Resolves a builtin virtual file and writes it to the VFS if it does not already exist
299
323
  *
@@ -302,7 +326,16 @@ interface UnresolvedContext<TResolvedConfig extends ResolvedConfig = ResolvedCon
302
326
  * @param path - An optional path to write the builtin file to
303
327
  * @param options - Additional options for writing the builtin file
304
328
  */
305
- emitBuiltin: (code: string, id: string, path?: string, options?: WriteOptions) => Promise<void>;
329
+ emitBuiltin: (code: string, id: string, path?: string, options?: EmitOptions) => Promise<void>;
330
+ /**
331
+ * Synchronously resolves a builtin virtual file and writes it to the VFS if it does not already exist
332
+ *
333
+ * @param code - The source code of the builtin file
334
+ * @param id - The unique identifier of the builtin file
335
+ * @param path - An optional path to write the builtin file to
336
+ * @param options - Additional options for writing the builtin file
337
+ */
338
+ emitBuiltinSync: (code: string, id: string, path?: string, options?: EmitOptions) => void;
306
339
  /**
307
340
  * Resolves a entry virtual file and writes it to the VFS if it does not already exist
308
341
  *
@@ -311,6 +344,14 @@ interface UnresolvedContext<TResolvedConfig extends ResolvedConfig = ResolvedCon
311
344
  * @param options - Additional options for writing the entry file
312
345
  */
313
346
  emitEntry: (code: string, path: string, options?: EmitEntryOptions) => Promise<void>;
347
+ /**
348
+ * Synchronously resolves a entry virtual file and writes it to the VFS if it does not already exist
349
+ *
350
+ * @param code - The source code of the entry file
351
+ * @param path - An optional path to write the entry file to
352
+ * @param options - Additional options for writing the entry file
353
+ */
354
+ emitEntrySync: (code: string, path: string, options?: EmitEntryOptions) => void;
314
355
  /**
315
356
  * A function to update the context fields using a new user configuration options
316
357
  */
@@ -13,6 +13,13 @@ interface StorageAdapter {
13
13
  * A name identifying the storage adapter type.
14
14
  */
15
15
  name: string;
16
+ /**
17
+ * The storage preset for the adapter.
18
+ *
19
+ * @remarks
20
+ * This can be used as an alternate way to identify the type of storage being used.
21
+ */
22
+ preset?: StoragePreset | null;
16
23
  /**
17
24
  * Checks if a key exists in the storage.
18
25
  *
@@ -207,6 +214,13 @@ interface WriteOptions {
207
214
  * @defaultValue false
208
215
  */
209
216
  skipFormat?: boolean;
217
+ /**
218
+ * The storage preset or adapter name for the output file.
219
+ *
220
+ * @remarks
221
+ * If not specified, the output mode will be determined by the provided `output.mode` value.
222
+ */
223
+ storage?: StoragePreset | string;
210
224
  /**
211
225
  * Additional metadata for the file.
212
226
  */
@@ -13,6 +13,13 @@ interface StorageAdapter {
13
13
  * A name identifying the storage adapter type.
14
14
  */
15
15
  name: string;
16
+ /**
17
+ * The storage preset for the adapter.
18
+ *
19
+ * @remarks
20
+ * This can be used as an alternate way to identify the type of storage being used.
21
+ */
22
+ preset?: StoragePreset | null;
16
23
  /**
17
24
  * Checks if a key exists in the storage.
18
25
  *
@@ -207,6 +214,13 @@ interface WriteOptions {
207
214
  * @defaultValue false
208
215
  */
209
216
  skipFormat?: boolean;
217
+ /**
218
+ * The storage preset or adapter name for the output file.
219
+ *
220
+ * @remarks
221
+ * If not specified, the output mode will be determined by the provided `output.mode` value.
222
+ */
223
+ storage?: StoragePreset | string;
210
224
  /**
211
225
  * Additional metadata for the file.
212
226
  */
@@ -1 +1 @@
1
- export{};
1
+ export { };
@@ -1 +1 @@
1
- export{};
1
+ export { };
@@ -1 +1 @@
1
- export{};
1
+ export { };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@powerlines/plugin-satori",
3
- "version": "0.1.115",
3
+ "version": "0.1.117",
4
4
  "type": "module",
5
5
  "description": "A Powerlines plugin to use Satori to generate SVG files from jsx/tsx components.",
6
6
  "repository": {
@@ -122,26 +122,26 @@
122
122
  "react-dom": { "optional": true }
123
123
  },
124
124
  "dependencies": {
125
- "@stryke/convert": "^0.6.29",
126
- "@stryke/fs": "^0.33.26",
127
- "@stryke/helpers": "^0.9.31",
128
- "@stryke/json": "^0.9.32",
129
- "@stryke/path": "^0.24.0",
130
- "@stryke/type-checks": "^0.5.14",
131
- "@stryke/types": "^0.10.28",
125
+ "@stryke/convert": "^0.6.30",
126
+ "@stryke/fs": "^0.33.27",
127
+ "@stryke/helpers": "^0.9.32",
128
+ "@stryke/json": "^0.9.33",
129
+ "@stryke/path": "^0.24.1",
130
+ "@stryke/type-checks": "^0.5.15",
131
+ "@stryke/types": "^0.10.29",
132
132
  "defu": "^6.1.4",
133
133
  "jiti": "^2.6.1",
134
- "powerlines": "^0.36.21",
134
+ "powerlines": "^0.36.23",
135
135
  "satori": "^0.18.3"
136
136
  },
137
137
  "devDependencies": {
138
- "@powerlines/nx": "^0.11.47",
139
- "@powerlines/plugin-plugin": "^0.12.68",
138
+ "@powerlines/nx": "^0.11.49",
139
+ "@powerlines/plugin-plugin": "^0.12.70",
140
140
  "@storm-software/config": "^1.134.74",
141
141
  "@types/node": "^24.10.4",
142
142
  "@types/react": "^19.2.7",
143
143
  "@types/react-dom": "^19.2.3"
144
144
  },
145
145
  "publishConfig": { "access": "public" },
146
- "gitHead": "b16324cf857ea5743fd7ad06e18607b1ba32abe0"
146
+ "gitHead": "be47e546b48b9a82e460b5c5d4f02fb66e821f18"
147
147
  }