wesl-plugin 0.6.7 → 0.6.15

package/dist/PluginExtension-CRGiifnw.d.ts

@@ -0,0 +1,49 @@
+import { ParsedRegistry, WeslJsPlugin } from "wesl";
+
+//#region ../wesl-tooling/src/LoadWeslToml.d.ts
+/** Configuration from wesl.toml */
+interface WeslToml {
+  /** glob search strings to find .wesl/.wgsl files. Relative to the toml directory. */
+  weslFiles: string[];
+  /** base directory for wesl files. Relative to the toml directory. */
+  weslRoot: string;
+  /** names of directly referenced wesl shader packages (e.g. npm package names) */
+  dependencies?: string[];
+}
+/** Information about the loaded wesl.toml file and its location */
+interface WeslTomlInfo {
+  /** The path to the toml file, relative to the cwd, undefined if no toml file */
+  tomlFile: string | undefined;
+  /** The absolute path to the directory that contains the toml.
+   * Paths inside the toml are relative to this. */
+  tomlDir: string;
+  /** The wesl root, relative to the projectDir.
+   * This lets loadModules do `path.resolve(projectDir, resolvedWeslRoot)` */
+  resolvedWeslRoot: string;
+  /** The underlying toml file */
+  toml: WeslToml;
+}
+//#endregion
+//#region src/PluginExtension.d.ts
+/** function type required for for emit extensions */
+type ExtensionEmitFn = (/** absolute path to the shader to which the extension is attached */
+shaderPath: string, /** support functions available to plugin extensions */
+pluginApi: PluginExtensionApi, /** static conditions specified on the js import */conditions?: Record<string, boolean>) => Promise<string>;
+/** an extension that runs inside the wesl-js build plugin */
+interface PluginExtension extends WeslJsPlugin {
+  /** javascript imports with this suffix will trigger the plugin */
+  extensionName: string;
+  /** generate javascript text for js/ts importers to use.
+   *   e.g. import myPluginJs from "./foo.wesl?myPlugin"; */
+  emitFn: ExtensionEmitFn;
+}
+/** api supplied to plugin extensions */
+interface PluginExtensionApi {
+  weslToml: () => Promise<WeslTomlInfo>;
+  weslSrc: () => Promise<Record<string, string>>;
+  weslRegistry: () => Promise<ParsedRegistry>;
+  weslMain: (baseId: string) => Promise<string>;
+  weslDependencies: () => Promise<string[]>;
+}
+//#endregion
+export { PluginExtension as n, PluginExtensionApi as r, ExtensionEmitFn as t };