@fluixi/compiler 1.0.0-alpha.83 → 1.0.0-alpha.84

package/dist/transform/templates.d.cts

@@ -0,0 +1,69 @@
+import MagicString from 'magic-string';
+import { type CompileTemplateOptions } from '../lower/compile-template.cjs';
+import type { IRLoadStrategy } from '../ir/nodes.cjs';
+import { type PropsDiagnostic } from './props.cjs';
+import { type IntrinsicDiagnostic } from './intrinsics.cjs';
+export interface TransformOptions extends CompileTemplateOptions {
+    /**
+     * Which authoring syntaxes to compile. Both lower to the same IR, so this is
+     * about which source forms are touched, not about output.
+     * @default 'both'
+     */
+    format?: 'jsx' | 'lit' | 'both';
+    /** Tag marking a template for compilation. @default 'html' */
+    litTag?: string;
+    /** Module the emitted runtime symbols are imported from. @default '@fluixi/dom' */
+    runtimeModule?: string;
+    /** Where reactive primitives come from. @default '@fluixi/reactive/signal' */
+    reactiveModule?: string;
+    /**
+     * Rewrite a component's destructured props into property reads, so
+     * `function Card({ title })` keeps updating instead of reading `title` once.
+     * The edits go into the same string as the template edits, so the map still points
+     * at what the author wrote.
+     * @default true
+     */
+    propsDestructure?: boolean;
+    /**
+     * Record where each reactive primitive was created, so the devtools graph can say where a
+     * node comes from. Development tooling: leave it off for production, which then carries
+     * none of it.
+     * @default false
+     */
+    sourceLocations?: boolean;
+    /**
+     * Trim this prefix off the file name a source mark records, so a location reads
+     * `src/app.tsx:5:16` rather than an absolute path that means nothing to whoever opens it.
+     */
+    sourceRoot?: string;
+    /**
+     * Compile the `$` reactive intrinsics — `$signal`, `$memo`, `$effect`, `$store` — into
+     * the runtime calls they stand for, importing what they need.
+     * @default true
+     */
+    intrinsics?: boolean;
+}
+export interface UnresolvedDiagnostic {
+    /** The tag nothing supplies. */
+    name: string;
+    message: string;
+}
+export interface LoadDiagnostic {
+    /** The component the directive was written on. */
+    name: string;
+    strategy: IRLoadStrategy;
+    message: string;
+}
+export interface TransformResult {
+    code: string;
+    map: ReturnType<MagicString['generateMap']>;
+    /** Props patterns the rewrite refused, when `propsDestructure` is on. */
+    propsDiagnostics?: PropsDiagnostic[];
+    /** `$` names the module bound itself, so the intrinsic did not fire. */
+    intrinsicDiagnostics?: IntrinsicDiagnostic[];
+    /** `load:` directives that could not take effect, and why. */
+    loadDiagnostics?: LoadDiagnostic[];
+    /** Capitalised tags nothing supplies — they compile to an undefined reference. */
+    unresolvedDiagnostics?: UnresolvedDiagnostic[];
+}
+export declare function transformTemplates(code: string, id: string, options?: TransformOptions): TransformResult | null;