@vue-jsx-vapor/compiler 2.6.4 → 2.6.7

package/dist/index.d.cts

@@ -1,7 +1,14 @@
-import { BaseCodegenResult, CodegenOptions as CodegenOptions$1, CommentNode, CompilerCompatOptions, CompilerOptions as CompilerOptions$1, CompoundExpressionNode, DirectiveNode, SimpleExpressionNode, TransformOptions as TransformOptions$1 } from "@vue/compiler-dom";
-import { JSXAttribute, JSXElement, JSXFragment, Node } from "@babel/types";
-import { Prettify } from "@vue/shared";
+import { JSXAttribute, JSXElement, JSXFragment, Node, SourceLocation } from "@babel/types";
+import { ParserPlugin } from "@babel/parser";
+import { RawSourceMap } from "source-map-js";
 
+//#region src/utils/error.d.ts
+
+interface CompilerError extends SyntaxError {
+  code: number | string;
+  loc?: SourceLocation | null;
+}
+//#endregion
 //#region src/transform.d.ts
 type NodeTransform = (node: BlockIRNode['node'], context: TransformContext<BlockIRNode['node']>) => void | (() => void) | (() => void)[];
 type DirectiveTransform = (dir: JSXAttribute, node: JSXElement, context: TransformContext<JSXElement>) => DirectiveTransformResult | void;
@@ -16,14 +23,31 @@ interface DirectiveTransformResult {
   modelModifiers?: string[];
 }
 type StructuralDirectiveTransform = (node: JSXElement, dir: JSXAttribute, context: TransformContext) => void | (() => void);
-type TransformOptions = HackOptions<TransformOptions$1> & {
+type TransformOptions = CodegenOptions & {
   source?: string;
-  templates?: string[];
   /**
-   * Compile JSX Component to createComponentWithFallback.
+   * Whether to compile components to createComponentWithFallback.
    * @default false
    */
   withFallback?: boolean;
+  /**
+   * Indicates that transforms and codegen should try to output valid TS code
+   */
+  isTS?: boolean;
+  /**
+   * An array of node transforms to be applied to every AST node.
+   */
+  nodeTransforms?: NodeTransform[];
+  /**
+   * An object of { name: transform } to be applied to every directive attribute
+   * node found on element nodes.
+   */
+  directiveTransforms?: Record<string, DirectiveTransform | undefined>;
+  /**
+   * Separate option for end users to extend the native elements list
+   */
+  isCustomElement?: (tag: string) => boolean | void;
+  onError?: (error: CompilerError) => void;
 };
 declare class TransformContext<T extends BlockIRNode['node'] = BlockIRNode['node']> {
   ir: RootIRNode;
@@ -32,13 +56,12 @@ declare class TransformContext<T extends BlockIRNode['node'] = BlockIRNode['node
   root: TransformContext<RootNode>;
   index: number;
   block: BlockIRNode;
-  options: Required<Omit<TransformOptions, 'filename' | 'inline' | 'bindingMetadata' | 'prefixIdentifiers' | keyof CompilerCompatOptions>>;
+  options: Required<TransformOptions>;
   template: string;
   childrenTemplate: (string | null)[];
   dynamic: IRDynamicInfo;
   inVOnce: boolean;
   inVFor: number;
-  comment: CommentNode[];
   component: Set<string>;
   directive: Set<string>;
   slots: IRSlots[];
@@ -57,6 +80,14 @@ declare function transform(node: RootNode, options?: TransformOptions): RootIRNo
 declare function transformNode(context: TransformContext<BlockIRNode['node']>): void;
 declare function createStructuralDirectiveTransform(name: string | string[], fn: StructuralDirectiveTransform): NodeTransform;
 //#endregion
+//#region src/utils/expression.d.ts
+interface SimpleExpressionNode {
+  content: string;
+  isStatic: boolean;
+  loc: SourceLocation | null | undefined;
+  ast?: Node;
+}
+//#endregion
 //#region src/ir/component.d.ts
 interface IRProp extends Omit<DirectiveTransformResult, 'value'> {
   values: SimpleExpressionNode[];
@@ -220,6 +251,7 @@ interface SetTextIRNode extends BaseIRNode {
 interface SetNodesIRNode extends BaseIRNode {
   type: IRNodeTypes.SET_NODES;
   element: number;
+  once: boolean;
   values: SimpleExpressionNode[];
   generated?: boolean;
 }
@@ -254,6 +286,7 @@ interface SetTemplateRefIRNode extends BaseIRNode {
 interface CreateNodesIRNode extends BaseIRNode {
   type: IRNodeTypes.CREATE_NODES;
   id: number;
+  once: boolean;
   values?: SimpleExpressionNode[];
 }
 interface InsertNodeIRNode extends BaseIRNode {
@@ -270,7 +303,7 @@ interface PrependNodeIRNode extends BaseIRNode {
 interface DirectiveIRNode extends BaseIRNode {
   type: IRNodeTypes.DIRECTIVE;
   element: number;
-  dir: VaporDirectiveNode;
+  dir: DirectiveNode;
   name: string;
   builtin?: boolean;
   asset?: boolean;
@@ -336,20 +369,43 @@ interface IREffect {
   expressions: SimpleExpressionNode[];
   operations: OperationNode[];
 }
-type Overwrite<T, U> = Pick<T, Exclude<keyof T, keyof U>> & Pick<U, Extract<keyof U, keyof T>>;
-type HackOptions<T> = Prettify<Overwrite<T, {
-  nodeTransforms?: NodeTransform[];
-  directiveTransforms?: Record<string, DirectiveTransform | undefined>;
-}>>;
-type VaporDirectiveNode = Overwrite<DirectiveNode, {
-  exp: Exclude<DirectiveNode['exp'], CompoundExpressionNode>;
-  arg: Exclude<DirectiveNode['arg'], CompoundExpressionNode>;
-}>;
 type InsertionStateTypes = IfIRNode | ForIRNode | SlotOutletIRNode | CreateComponentIRNode;
 declare function isBlockOperation(op: OperationNode): op is InsertionStateTypes;
+interface DirectiveNode {
+  /**
+   * the normalized name without prefix or shorthands, e.g. "bind", "on"
+   */
+  name: string;
+  /**
+   * the raw attribute name, preserving shorthand, and including arg & modifiers
+   * this is only used during parse.
+   */
+  rawName?: string;
+  exp: SimpleExpressionNode | undefined;
+  arg: SimpleExpressionNode | undefined;
+  modifiers: SimpleExpressionNode[];
+  loc: SourceLocation;
+}
 //#endregion
 //#region src/generate.d.ts
-type CodegenOptions = Omit<CodegenOptions$1, 'optimizeImports' | 'inline' | 'bindingMetadata' | 'prefixIdentifiers'> & {
+type CodegenOptions = {
+  /**
+   * Generate source map?
+   * @default false
+   */
+  sourceMap?: boolean;
+  /**
+   * Filename for source map generation.
+   * Also used for self-recursive reference in templates
+   * @default 'index.jsx'
+   */
+  filename?: string;
+  /**
+   * A list of parser plugins to enable for `@babel/parser`, which is used to
+   * parse expressions in bindings and interpolations.
+   * https://babeljs.io/docs/en/next/babel-parser#plugins
+   */
+  expressionPlugins?: ParserPlugin[];
   templates?: string[];
 };
 declare class CodegenContext {
@@ -366,17 +422,19 @@ declare class CodegenContext {
   enterScope(): [level: number, exit: () => number];
   constructor(ir: RootIRNode, options: CodegenOptions);
 }
-interface VaporCodegenResult extends Omit<BaseCodegenResult, 'preamble'> {
+interface VaporCodegenResult {
   ast: RootIRNode;
   helpers: Set<string>;
   templates: string[];
   delegates: Set<string>;
+  code: string;
+  map?: RawSourceMap;
 }
 declare function generate(ir: RootIRNode, options?: CodegenOptions): VaporCodegenResult;
 //#endregion
 //#region src/compile.d.ts
 declare function compile(source: JSXElement | JSXFragment | string, options?: CompilerOptions): VaporCodegenResult;
-type CompilerOptions = HackOptions<CompilerOptions$1> & TransformOptions;
+type CompilerOptions = TransformOptions;
 type TransformPreset = [NodeTransform[], Record<string, DirectiveTransform>];
 //#endregion
 //#region src/transforms/transformText.d.ts
@@ -424,4 +482,4 @@ declare const transformVOnce: NodeTransform;
 //#region src/transforms/vText.d.ts
 declare const transformVText: DirectiveTransform;
 //#endregion
-export { BaseIRNode, BlockIRNode, CodegenContext, CodegenOptions, CompilerOptions, CreateComponentIRNode, CreateNodesIRNode, DeclareOldRefIRNode, DirectiveIRNode, DirectiveTransform, DirectiveTransformResult, DynamicFlag, ForIRNode, GetTextChildIRNode, HackOptions, IRDynamicInfo, IRDynamicPropsKind, IREffect, IRFor, IRNode, IRNodeTypes, IRProp, IRProps, IRPropsDynamicAttribute, IRPropsDynamicExpression, IRPropsStatic, IRSlotDynamic, IRSlotDynamicBasic, IRSlotDynamicConditional, IRSlotDynamicLoop, IRSlotType, IRSlots, IRSlotsExpression, IRSlotsStatic, IfIRNode, InsertNodeIRNode, InsertionStateTypes, KeyOverride, NodeTransform, OperationNode, PrependNodeIRNode, RootIRNode, RootNode, SetDynamicEventsIRNode, SetDynamicPropsIRNode, SetEventIRNode, SetHtmlIRNode, SetNodesIRNode, SetPropIRNode, SetTemplateRefIRNode, SetTextIRNode, SlotBlockIRNode, SlotOutletIRNode, StructuralDirectiveTransform, TransformContext, TransformOptions, TransformPreset, VaporCodegenResult, VaporDirectiveNode, compile, createStructuralDirectiveTransform, generate, isBlockOperation, transform, transformChildren, transformElement, transformNode, transformTemplateRef, transformText, transformVBind, transformVFor, transformVHtml, transformVIf, transformVModel, transformVOn, transformVOnce, transformVShow, transformVSlot, transformVSlots, transformVText };
+export { BaseIRNode, BlockIRNode, CodegenContext, CodegenOptions, CompilerOptions, CreateComponentIRNode, CreateNodesIRNode, DeclareOldRefIRNode, DirectiveIRNode, DirectiveNode, DirectiveTransform, DirectiveTransformResult, DynamicFlag, ForIRNode, GetTextChildIRNode, IRDynamicInfo, IRDynamicPropsKind, IREffect, IRFor, IRNode, IRNodeTypes, IRProp, IRProps, IRPropsDynamicAttribute, IRPropsDynamicExpression, IRPropsStatic, IRSlotDynamic, IRSlotDynamicBasic, IRSlotDynamicConditional, IRSlotDynamicLoop, IRSlotType, IRSlots, IRSlotsExpression, IRSlotsStatic, IfIRNode, InsertNodeIRNode, InsertionStateTypes, KeyOverride, NodeTransform, OperationNode, PrependNodeIRNode, RootIRNode, RootNode, SetDynamicEventsIRNode, SetDynamicPropsIRNode, SetEventIRNode, SetHtmlIRNode, SetNodesIRNode, SetPropIRNode, SetTemplateRefIRNode, SetTextIRNode, SlotBlockIRNode, SlotOutletIRNode, StructuralDirectiveTransform, TransformContext, TransformOptions, TransformPreset, VaporCodegenResult, compile, createStructuralDirectiveTransform, generate, isBlockOperation, transform, transformChildren, transformElement, transformNode, transformTemplateRef, transformText, transformVBind, transformVFor, transformVHtml, transformVIf, transformVModel, transformVOn, transformVOnce, transformVShow, transformVSlot, transformVSlots, transformVText };

package/dist/index.d.ts

@@ -1,7 +1,14 @@
-import { Prettify } from "@vue/shared";
-import { BaseCodegenResult, CodegenOptions as CodegenOptions$1, CommentNode, CompilerCompatOptions, CompilerOptions as CompilerOptions$1, CompoundExpressionNode, DirectiveNode, SimpleExpressionNode, TransformOptions as TransformOptions$1 } from "@vue/compiler-dom";
-import { JSXAttribute, JSXElement, JSXFragment, Node } from "@babel/types";
+import { ParserPlugin } from "@babel/parser";
+import { RawSourceMap } from "source-map-js";
+import { JSXAttribute, JSXElement, JSXFragment, Node, SourceLocation } from "@babel/types";
 
+//#region src/utils/error.d.ts
+
+interface CompilerError extends SyntaxError {
+  code: number | string;
+  loc?: SourceLocation | null;
+}
+//#endregion
 //#region src/transform.d.ts
 type NodeTransform = (node: BlockIRNode['node'], context: TransformContext<BlockIRNode['node']>) => void | (() => void) | (() => void)[];
 type DirectiveTransform = (dir: JSXAttribute, node: JSXElement, context: TransformContext<JSXElement>) => DirectiveTransformResult | void;
@@ -16,14 +23,31 @@ interface DirectiveTransformResult {
   modelModifiers?: string[];
 }
 type StructuralDirectiveTransform = (node: JSXElement, dir: JSXAttribute, context: TransformContext) => void | (() => void);
-type TransformOptions = HackOptions<TransformOptions$1> & {
+type TransformOptions = CodegenOptions & {
   source?: string;
-  templates?: string[];
   /**
-   * Compile JSX Component to createComponentWithFallback.
+   * Whether to compile components to createComponentWithFallback.
    * @default false
    */
   withFallback?: boolean;
+  /**
+   * Indicates that transforms and codegen should try to output valid TS code
+   */
+  isTS?: boolean;
+  /**
+   * An array of node transforms to be applied to every AST node.
+   */
+  nodeTransforms?: NodeTransform[];
+  /**
+   * An object of { name: transform } to be applied to every directive attribute
+   * node found on element nodes.
+   */
+  directiveTransforms?: Record<string, DirectiveTransform | undefined>;
+  /**
+   * Separate option for end users to extend the native elements list
+   */
+  isCustomElement?: (tag: string) => boolean | void;
+  onError?: (error: CompilerError) => void;
 };
 declare class TransformContext<T extends BlockIRNode['node'] = BlockIRNode['node']> {
   ir: RootIRNode;
@@ -32,13 +56,12 @@ declare class TransformContext<T extends BlockIRNode['node'] = BlockIRNode['node
   root: TransformContext<RootNode>;
   index: number;
   block: BlockIRNode;
-  options: Required<Omit<TransformOptions, 'filename' | 'inline' | 'bindingMetadata' | 'prefixIdentifiers' | keyof CompilerCompatOptions>>;
+  options: Required<TransformOptions>;
   template: string;
   childrenTemplate: (string | null)[];
   dynamic: IRDynamicInfo;
   inVOnce: boolean;
   inVFor: number;
-  comment: CommentNode[];
   component: Set<string>;
   directive: Set<string>;
   slots: IRSlots[];
@@ -57,6 +80,14 @@ declare function transform(node: RootNode, options?: TransformOptions): RootIRNo
 declare function transformNode(context: TransformContext<BlockIRNode['node']>): void;
 declare function createStructuralDirectiveTransform(name: string | string[], fn: StructuralDirectiveTransform): NodeTransform;
 //#endregion
+//#region src/utils/expression.d.ts
+interface SimpleExpressionNode {
+  content: string;
+  isStatic: boolean;
+  loc: SourceLocation | null | undefined;
+  ast?: Node;
+}
+//#endregion
 //#region src/ir/component.d.ts
 interface IRProp extends Omit<DirectiveTransformResult, 'value'> {
   values: SimpleExpressionNode[];
@@ -220,6 +251,7 @@ interface SetTextIRNode extends BaseIRNode {
 interface SetNodesIRNode extends BaseIRNode {
   type: IRNodeTypes.SET_NODES;
   element: number;
+  once: boolean;
   values: SimpleExpressionNode[];
   generated?: boolean;
 }
@@ -254,6 +286,7 @@ interface SetTemplateRefIRNode extends BaseIRNode {
 interface CreateNodesIRNode extends BaseIRNode {
   type: IRNodeTypes.CREATE_NODES;
   id: number;
+  once: boolean;
   values?: SimpleExpressionNode[];
 }
 interface InsertNodeIRNode extends BaseIRNode {
@@ -270,7 +303,7 @@ interface PrependNodeIRNode extends BaseIRNode {
 interface DirectiveIRNode extends BaseIRNode {
   type: IRNodeTypes.DIRECTIVE;
   element: number;
-  dir: VaporDirectiveNode;
+  dir: DirectiveNode;
   name: string;
   builtin?: boolean;
   asset?: boolean;
@@ -336,20 +369,43 @@ interface IREffect {
   expressions: SimpleExpressionNode[];
   operations: OperationNode[];
 }
-type Overwrite<T, U> = Pick<T, Exclude<keyof T, keyof U>> & Pick<U, Extract<keyof U, keyof T>>;
-type HackOptions<T> = Prettify<Overwrite<T, {
-  nodeTransforms?: NodeTransform[];
-  directiveTransforms?: Record<string, DirectiveTransform | undefined>;
-}>>;
-type VaporDirectiveNode = Overwrite<DirectiveNode, {
-  exp: Exclude<DirectiveNode['exp'], CompoundExpressionNode>;
-  arg: Exclude<DirectiveNode['arg'], CompoundExpressionNode>;
-}>;
 type InsertionStateTypes = IfIRNode | ForIRNode | SlotOutletIRNode | CreateComponentIRNode;
 declare function isBlockOperation(op: OperationNode): op is InsertionStateTypes;
+interface DirectiveNode {
+  /**
+   * the normalized name without prefix or shorthands, e.g. "bind", "on"
+   */
+  name: string;
+  /**
+   * the raw attribute name, preserving shorthand, and including arg & modifiers
+   * this is only used during parse.
+   */
+  rawName?: string;
+  exp: SimpleExpressionNode | undefined;
+  arg: SimpleExpressionNode | undefined;
+  modifiers: SimpleExpressionNode[];
+  loc: SourceLocation;
+}
 //#endregion
 //#region src/generate.d.ts
-type CodegenOptions = Omit<CodegenOptions$1, 'optimizeImports' | 'inline' | 'bindingMetadata' | 'prefixIdentifiers'> & {
+type CodegenOptions = {
+  /**
+   * Generate source map?
+   * @default false
+   */
+  sourceMap?: boolean;
+  /**
+   * Filename for source map generation.
+   * Also used for self-recursive reference in templates
+   * @default 'index.jsx'
+   */
+  filename?: string;
+  /**
+   * A list of parser plugins to enable for `@babel/parser`, which is used to
+   * parse expressions in bindings and interpolations.
+   * https://babeljs.io/docs/en/next/babel-parser#plugins
+   */
+  expressionPlugins?: ParserPlugin[];
   templates?: string[];
 };
 declare class CodegenContext {
@@ -366,17 +422,19 @@ declare class CodegenContext {
   enterScope(): [level: number, exit: () => number];
   constructor(ir: RootIRNode, options: CodegenOptions);
 }
-interface VaporCodegenResult extends Omit<BaseCodegenResult, 'preamble'> {
+interface VaporCodegenResult {
   ast: RootIRNode;
   helpers: Set<string>;
   templates: string[];
   delegates: Set<string>;
+  code: string;
+  map?: RawSourceMap;
 }
 declare function generate(ir: RootIRNode, options?: CodegenOptions): VaporCodegenResult;
 //#endregion
 //#region src/compile.d.ts
 declare function compile(source: JSXElement | JSXFragment | string, options?: CompilerOptions): VaporCodegenResult;
-type CompilerOptions = HackOptions<CompilerOptions$1> & TransformOptions;
+type CompilerOptions = TransformOptions;
 type TransformPreset = [NodeTransform[], Record<string, DirectiveTransform>];
 //#endregion
 //#region src/transforms/transformText.d.ts
@@ -424,4 +482,4 @@ declare const transformVOnce: NodeTransform;
 //#region src/transforms/vText.d.ts
 declare const transformVText: DirectiveTransform;
 //#endregion
-export { BaseIRNode, BlockIRNode, CodegenContext, CodegenOptions, CompilerOptions, CreateComponentIRNode, CreateNodesIRNode, DeclareOldRefIRNode, DirectiveIRNode, DirectiveTransform, DirectiveTransformResult, DynamicFlag, ForIRNode, GetTextChildIRNode, HackOptions, IRDynamicInfo, IRDynamicPropsKind, IREffect, IRFor, IRNode, IRNodeTypes, IRProp, IRProps, IRPropsDynamicAttribute, IRPropsDynamicExpression, IRPropsStatic, IRSlotDynamic, IRSlotDynamicBasic, IRSlotDynamicConditional, IRSlotDynamicLoop, IRSlotType, IRSlots, IRSlotsExpression, IRSlotsStatic, IfIRNode, InsertNodeIRNode, InsertionStateTypes, KeyOverride, NodeTransform, OperationNode, PrependNodeIRNode, RootIRNode, RootNode, SetDynamicEventsIRNode, SetDynamicPropsIRNode, SetEventIRNode, SetHtmlIRNode, SetNodesIRNode, SetPropIRNode, SetTemplateRefIRNode, SetTextIRNode, SlotBlockIRNode, SlotOutletIRNode, StructuralDirectiveTransform, TransformContext, TransformOptions, TransformPreset, VaporCodegenResult, VaporDirectiveNode, compile, createStructuralDirectiveTransform, generate, isBlockOperation, transform, transformChildren, transformElement, transformNode, transformTemplateRef, transformText, transformVBind, transformVFor, transformVHtml, transformVIf, transformVModel, transformVOn, transformVOnce, transformVShow, transformVSlot, transformVSlots, transformVText };
+export { BaseIRNode, BlockIRNode, CodegenContext, CodegenOptions, CompilerOptions, CreateComponentIRNode, CreateNodesIRNode, DeclareOldRefIRNode, DirectiveIRNode, DirectiveNode, DirectiveTransform, DirectiveTransformResult, DynamicFlag, ForIRNode, GetTextChildIRNode, IRDynamicInfo, IRDynamicPropsKind, IREffect, IRFor, IRNode, IRNodeTypes, IRProp, IRProps, IRPropsDynamicAttribute, IRPropsDynamicExpression, IRPropsStatic, IRSlotDynamic, IRSlotDynamicBasic, IRSlotDynamicConditional, IRSlotDynamicLoop, IRSlotType, IRSlots, IRSlotsExpression, IRSlotsStatic, IfIRNode, InsertNodeIRNode, InsertionStateTypes, KeyOverride, NodeTransform, OperationNode, PrependNodeIRNode, RootIRNode, RootNode, SetDynamicEventsIRNode, SetDynamicPropsIRNode, SetEventIRNode, SetHtmlIRNode, SetNodesIRNode, SetPropIRNode, SetTemplateRefIRNode, SetTextIRNode, SlotBlockIRNode, SlotOutletIRNode, StructuralDirectiveTransform, TransformContext, TransformOptions, TransformPreset, VaporCodegenResult, compile, createStructuralDirectiveTransform, generate, isBlockOperation, transform, transformChildren, transformElement, transformNode, transformTemplateRef, transformText, transformVBind, transformVFor, transformVHtml, transformVIf, transformVModel, transformVOn, transformVOnce, transformVShow, transformVSlot, transformVSlots, transformVText };