@vue/compiler-core 3.4.0-alpha.1 → 3.4.0-alpha.3

package/dist/compiler-core.d.ts

@@ -3,27 +3,51 @@ import { RawSourceMap, SourceMapGenerator } from 'source-map-js';
 import { Node as Node$1, Identifier, Function, BlockStatement as BlockStatement$1, Program, ObjectProperty } from '@babel/types';
 export { generateCodeFrame } from '@vue/shared';
 
-type OptionalOptions = 'whitespace' | 'isNativeTag' | 'isBuiltInComponent' | keyof CompilerCompatOptions;
+export declare const FRAGMENT: unique symbol;
+export declare const TELEPORT: unique symbol;
+export declare const SUSPENSE: unique symbol;
+export declare const KEEP_ALIVE: unique symbol;
+export declare const BASE_TRANSITION: unique symbol;
+export declare const OPEN_BLOCK: unique symbol;
+export declare const CREATE_BLOCK: unique symbol;
+export declare const CREATE_ELEMENT_BLOCK: unique symbol;
+export declare const CREATE_VNODE: unique symbol;
+export declare const CREATE_ELEMENT_VNODE: unique symbol;
+export declare const CREATE_COMMENT: unique symbol;
+export declare const CREATE_TEXT: unique symbol;
+export declare const CREATE_STATIC: unique symbol;
+export declare const RESOLVE_COMPONENT: unique symbol;
+export declare const RESOLVE_DYNAMIC_COMPONENT: unique symbol;
+export declare const RESOLVE_DIRECTIVE: unique symbol;
+export declare const RESOLVE_FILTER: unique symbol;
+export declare const WITH_DIRECTIVES: unique symbol;
+export declare const RENDER_LIST: unique symbol;
+export declare const RENDER_SLOT: unique symbol;
+export declare const CREATE_SLOTS: unique symbol;
+export declare const TO_DISPLAY_STRING: unique symbol;
+export declare const MERGE_PROPS: unique symbol;
+export declare const NORMALIZE_CLASS: unique symbol;
+export declare const NORMALIZE_STYLE: unique symbol;
+export declare const NORMALIZE_PROPS: unique symbol;
+export declare const GUARD_REACTIVE_PROPS: unique symbol;
+export declare const TO_HANDLERS: unique symbol;
+export declare const CAMELIZE: unique symbol;
+export declare const CAPITALIZE: unique symbol;
+export declare const TO_HANDLER_KEY: unique symbol;
+export declare const SET_BLOCK_TRACKING: unique symbol;
+export declare const PUSH_SCOPE_ID: unique symbol;
+export declare const POP_SCOPE_ID: unique symbol;
+export declare const WITH_CTX: unique symbol;
+export declare const UNREF: unique symbol;
+export declare const IS_REF: unique symbol;
+export declare const WITH_MEMO: unique symbol;
+export declare const IS_MEMO_SAME: unique symbol;
+export declare const helperNameMap: Record<symbol, string>;
+export declare function registerRuntimeHelpers(helpers: Record<symbol, string>): void;
+
+type OptionalOptions = 'decodeEntities' | 'whitespace' | 'isNativeTag' | 'isBuiltInComponent' | keyof CompilerCompatOptions;
 type MergedParserOptions = Omit<Required<ParserOptions>, OptionalOptions> & Pick<ParserOptions, OptionalOptions>;
-export declare const enum TextModes {
-    DATA = 0,
-    RCDATA = 1,
-    RAWTEXT = 2,
-    CDATA = 3,
-    ATTRIBUTE_VALUE = 4
-}
-interface ParserContext {
-    options: MergedParserOptions;
-    readonly originalSource: string;
-    source: string;
-    offset: number;
-    line: number;
-    column: number;
-    inPre: boolean;
-    inVPre: boolean;
-    onWarn: NonNullable<ErrorHandlingOptions['onWarn']>;
-}
-export declare function baseParse(content: string, options?: ParserOptions): RootNode;
+export declare function baseParse(input: string, options?: ParserOptions): RootNode;
 
 type CompilerCompatConfig = Partial<Record<CompilerDeprecationTypes, boolean | 'suppress-warning'>> & {
     MODE?: 2 | 3;
@@ -34,7 +58,6 @@ interface CompilerCompatOptions {
 export declare const enum CompilerDeprecationTypes {
     COMPILER_IS_ON_ELEMENT = "COMPILER_IS_ON_ELEMENT",
     COMPILER_V_BIND_SYNC = "COMPILER_V_BIND_SYNC",
-    COMPILER_V_BIND_PROP = "COMPILER_V_BIND_PROP",
     COMPILER_V_BIND_OBJECT_ORDER = "COMPILER_V_BIND_OBJECT_ORDER",
     COMPILER_V_ON_NATIVE = "COMPILER_V_ON_NATIVE",
     COMPILER_V_IF_V_FOR_PRECEDENCE = "COMPILER_V_IF_V_FOR_PRECEDENCE",
@@ -42,8 +65,8 @@ export declare const enum CompilerDeprecationTypes {
     COMPILER_INLINE_TEMPLATE = "COMPILER_INLINE_TEMPLATE",
     COMPILER_FILTERS = "COMPILER_FILTER"
 }
-export declare function checkCompatEnabled(key: CompilerDeprecationTypes, context: ParserContext | TransformContext, loc: SourceLocation | null, ...args: any[]): boolean;
-export declare function warnDeprecation(key: CompilerDeprecationTypes, context: ParserContext | TransformContext, loc: SourceLocation | null, ...args: any[]): void;
+export declare function checkCompatEnabled(key: CompilerDeprecationTypes, context: MergedParserOptions | TransformContext, loc: SourceLocation | null, ...args: any[]): boolean;
+export declare function warnDeprecation(key: CompilerDeprecationTypes, context: MergedParserOptions | TransformContext, loc: SourceLocation | null, ...args: any[]): void;
 
 export type NodeTransform = (node: RootNode | TemplateChildNode, context: TransformContext) => void | (() => void) | (() => void)[];
 export type DirectiveTransform = (dir: DirectiveNode, node: ElementNode, context: TransformContext, augmentor?: (ret: DirectiveTransformResult) => DirectiveTransformResult) => DirectiveTransformResult;
@@ -98,57 +121,6 @@ export declare function transform(root: RootNode, options: TransformOptions): vo
 export declare function traverseNode(node: RootNode | TemplateChildNode, context: TransformContext): void;
 export declare function createStructuralDirectiveTransform(name: string | RegExp, fn: StructuralDirectiveTransform): NodeTransform;
 
-export declare function processFor(node: ElementNode, dir: DirectiveNode, context: TransformContext, processCodegen?: (forNode: ForNode) => (() => void) | undefined): (() => void) | undefined;
-interface ForParseResult {
-    source: ExpressionNode;
-    value: ExpressionNode | undefined;
-    key: ExpressionNode | undefined;
-    index: ExpressionNode | undefined;
-}
-export declare function createForLoopParams({ value, key, index }: ForParseResult, memoArgs?: ExpressionNode[]): ExpressionNode[];
-
-export declare const FRAGMENT: unique symbol;
-export declare const TELEPORT: unique symbol;
-export declare const SUSPENSE: unique symbol;
-export declare const KEEP_ALIVE: unique symbol;
-export declare const BASE_TRANSITION: unique symbol;
-export declare const OPEN_BLOCK: unique symbol;
-export declare const CREATE_BLOCK: unique symbol;
-export declare const CREATE_ELEMENT_BLOCK: unique symbol;
-export declare const CREATE_VNODE: unique symbol;
-export declare const CREATE_ELEMENT_VNODE: unique symbol;
-export declare const CREATE_COMMENT: unique symbol;
-export declare const CREATE_TEXT: unique symbol;
-export declare const CREATE_STATIC: unique symbol;
-export declare const RESOLVE_COMPONENT: unique symbol;
-export declare const RESOLVE_DYNAMIC_COMPONENT: unique symbol;
-export declare const RESOLVE_DIRECTIVE: unique symbol;
-export declare const RESOLVE_FILTER: unique symbol;
-export declare const WITH_DIRECTIVES: unique symbol;
-export declare const RENDER_LIST: unique symbol;
-export declare const RENDER_SLOT: unique symbol;
-export declare const CREATE_SLOTS: unique symbol;
-export declare const TO_DISPLAY_STRING: unique symbol;
-export declare const MERGE_PROPS: unique symbol;
-export declare const NORMALIZE_CLASS: unique symbol;
-export declare const NORMALIZE_STYLE: unique symbol;
-export declare const NORMALIZE_PROPS: unique symbol;
-export declare const GUARD_REACTIVE_PROPS: unique symbol;
-export declare const TO_HANDLERS: unique symbol;
-export declare const CAMELIZE: unique symbol;
-export declare const CAPITALIZE: unique symbol;
-export declare const TO_HANDLER_KEY: unique symbol;
-export declare const SET_BLOCK_TRACKING: unique symbol;
-export declare const PUSH_SCOPE_ID: unique symbol;
-export declare const POP_SCOPE_ID: unique symbol;
-export declare const WITH_CTX: unique symbol;
-export declare const UNREF: unique symbol;
-export declare const IS_REF: unique symbol;
-export declare const WITH_MEMO: unique symbol;
-export declare const IS_MEMO_SAME: unique symbol;
-export declare const helperNameMap: Record<symbol, string>;
-export declare function registerRuntimeHelpers(helpers: Record<symbol, string>): void;
-
 export declare const transformElement: NodeTransform;
 export declare function resolveComponentType(node: ComponentNode, context: TransformContext, ssr?: boolean): string | symbol | CallExpression;
 export type PropsExpression = ObjectExpression | CallExpression | ExpressionNode;
@@ -163,7 +135,9 @@ export declare function buildDirectiveArgs(dir: DirectiveNode, context: Transfor
 
 export type Namespace = number;
 export declare const enum Namespaces {
-    HTML = 0
+    HTML = 0,
+    SVG = 1,
+    MATH_ML = 2
 }
 export declare const enum NodeTypes {
     ROOT = 0,
@@ -219,6 +193,7 @@ export type ExpressionNode = SimpleExpressionNode | CompoundExpressionNode;
 export type TemplateChildNode = ElementNode | InterpolationNode | CompoundExpressionNode | TextNode | CommentNode | IfNode | IfBranchNode | ForNode | TextCallNode;
 export interface RootNode extends Node {
     type: NodeTypes.ROOT;
+    source: string;
     children: TemplateChildNode[];
     helpers: Set<symbol>;
     components: string[];
@@ -229,6 +204,7 @@ export interface RootNode extends Node {
     temps: number;
     ssrHelpers?: symbol[];
     codegenNode?: TemplateChildNode | JSChildNode | BlockStatement;
+    transformed?: boolean;
     filters?: string[];
 }
 export type ElementNode = PlainElementNode | ComponentNode | SlotOutletNode | TemplateNode;
@@ -237,9 +213,10 @@ export interface BaseElementNode extends Node {
     ns: Namespace;
     tag: string;
     tagType: ElementTypes;
-    isSelfClosing: boolean;
     props: Array<AttributeNode | DirectiveNode>;
     children: TemplateChildNode[];
+    isSelfClosing?: boolean;
+    innerLoc?: SourceLocation;
 }
 export interface PlainElementNode extends BaseElementNode {
     tagType: ElementTypes.ELEMENT;
@@ -271,18 +248,27 @@ export interface CommentNode extends Node {
 export interface AttributeNode extends Node {
     type: NodeTypes.ATTRIBUTE;
     name: string;
+    nameLoc: SourceLocation;
     value: TextNode | undefined;
 }
 export interface DirectiveNode extends Node {
     type: NodeTypes.DIRECTIVE;
+    /**
+     * 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: ExpressionNode | undefined;
     arg: ExpressionNode | undefined;
     modifiers: string[];
     /**
      * optional property to cache the expression parse result for v-for
      */
-    parseResult?: ForParseResult;
+    forParseResult?: ForParseResult;
 }
 /**
  * Static types have several levels.
@@ -348,6 +334,13 @@ export interface ForNode extends Node {
     children: TemplateChildNode[];
     codegenNode?: ForCodegenNode;
 }
+export interface ForParseResult {
+    source: ExpressionNode;
+    value: ExpressionNode | undefined;
+    key: ExpressionNode | undefined;
+    index: ExpressionNode | undefined;
+    finalized: boolean;
+}
 export interface TextCallNode extends Node {
     type: NodeTypes.TEXT_CALL;
     content: TextNode | InterpolationNode | CompoundExpressionNode;
@@ -520,7 +513,7 @@ export interface ForIteratorExpression extends FunctionExpression {
     returns: BlockCodegenNode;
 }
 export declare const locStub: SourceLocation;
-export declare function createRoot(children: TemplateChildNode[], loc?: SourceLocation): RootNode;
+export declare function createRoot(children: TemplateChildNode[], source?: string): RootNode;
 export declare function createVNodeCall(context: TransformContext | null, tag: VNodeCall['tag'], props?: VNodeCall['props'], children?: VNodeCall['children'], patchFlag?: VNodeCall['patchFlag'], dynamicProps?: VNodeCall['dynamicProps'], directives?: VNodeCall['directives'], isBlock?: VNodeCall['isBlock'], disableTracking?: VNodeCall['disableTracking'], isComponent?: VNodeCall['isComponent'], loc?: SourceLocation): VNodeCall;
 export declare function createArrayExpression(elements: ArrayExpression['elements'], loc?: SourceLocation): ArrayExpression;
 export declare function createObjectExpression(properties: ObjectExpression['properties'], loc?: SourceLocation): ObjectExpression;
@@ -617,6 +610,24 @@ interface ErrorHandlingOptions {
     onError?: (error: CompilerError) => void;
 }
 export interface ParserOptions extends ErrorHandlingOptions, CompilerCompatOptions {
+    /**
+     * Base mode is platform agnostic and only parses HTML-like template syntax,
+     * treating all tags the same way. Specific tag parsing behavior can be
+     * configured by higher-level compilers.
+     *
+     * HTML mode adds additional logic for handling special parsing behavior in
+     * `<script>`, `<style>`,`<title>` and `<textarea>`.
+     * The logic is handled inside compiler-core for efficiency.
+     *
+     * SFC mode treats content of all root-level tags except `<template>` as plain
+     * text.
+     */
+    parseMode?: 'base' | 'html' | 'sfc';
+    /**
+     * Specify the root namepsace to use when parsing a tempalte.
+     * Defaults to `Namepsaces.HTML` (0).
+     */
+    ns?: Namespaces;
     /**
      * e.g. platform native elements, e.g. `<div>` for browsers
      */
@@ -640,11 +651,7 @@ export interface ParserOptions extends ErrorHandlingOptions, CompilerCompatOptio
     /**
      * Get tag namespace
      */
-    getNamespace?: (tag: string, parent: ElementNode | undefined) => Namespace;
-    /**
-     * Get text parsing mode for this element
-     */
-    getTextMode?: (node: ElementNode, parent: ElementNode | undefined) => TextModes;
+    getNamespace?: (tag: string, parent: ElementNode | undefined, rootNamespace: Namespace) => Namespace;
     /**
      * @default ['{{', '}}']
      */
@@ -654,7 +661,8 @@ export interface ParserOptions extends ErrorHandlingOptions, CompilerCompatOptio
      */
     whitespace?: 'preserve' | 'condense';
     /**
-     * Only needed for DOM compilers
+     * Only used for DOM compilers that runs in the browser.
+     * In non-browser builds, this option is ignored.
      */
     decodeEntities?: (rawText: string, asAttr: boolean) => string;
     /**
@@ -910,7 +918,7 @@ export interface CodegenContext extends Omit<Required<CodegenOptions>, 'bindingM
     pure: boolean;
     map?: SourceMapGenerator;
     helper(key: symbol): string;
-    push(code: string, node?: CodegenNode): void;
+    push(code: string, newlineIndex?: number, node?: CodegenNode): void;
     indent(): void;
     deindent(withoutNewLine?: boolean): void;
     newline(): void;
@@ -924,10 +932,9 @@ export type TransformPreset = [
     Record<string, DirectiveTransform>
 ];
 export declare function getBaseTransformPreset(prefixIdentifiers?: boolean): TransformPreset;
-export declare function baseCompile(template: string | RootNode, options?: CompilerOptions): CodegenResult;
+export declare function baseCompile(source: string | RootNode, options?: CompilerOptions): CodegenResult;
 
 export declare const isStaticExp: (p: JSChildNode) => p is SimpleExpressionNode;
-export declare const isBuiltInType: (tag: string, expected: string) => boolean;
 export declare function isCoreComponent(tag: string): symbol | void;
 export declare const isSimpleIdentifier: (name: string) => boolean;
 /**
@@ -939,7 +946,6 @@ export declare const isSimpleIdentifier: (name: string) => boolean;
 export declare const isMemberExpressionBrowser: (path: string) => boolean;
 export declare const isMemberExpressionNode: (path: string, context: TransformContext) => boolean;
 export declare const isMemberExpression: (path: string, context: TransformContext) => boolean;
-export declare function getInnerRange(loc: SourceLocation, offset: number, length: number): SourceLocation;
 export declare function advancePositionWithClone(pos: Position, source: string, numberOfCharacters?: number): Position;
 export declare function advancePositionWithMutation(pos: Position, source: string, numberOfCharacters?: number): Position;
 export declare function assert(condition: boolean, msg?: string): void;
@@ -955,6 +961,7 @@ export declare function injectProp(node: VNodeCall | RenderSlotCall, prop: Prope
 export declare function toValidAssetId(name: string, type: 'component' | 'directive' | 'filter'): string;
 export declare function hasScopeRef(node: TemplateChildNode | IfBranchNode | ExpressionNode | undefined, ids: TransformContext['identifiers']): boolean;
 export declare function getMemoedVNodeCall(node: BlockCodegenNode | MemoExpression): VNodeCall | RenderSlotCall;
+export declare const forAliasRE: RegExp;
 
 export declare function walkIdentifiers(root: Node$1, onIdentifier: (node: Identifier, parent: Node$1, parentStack: Node$1[], isReference: boolean, isLocal: boolean) => void, includeAll?: boolean, parentStack?: Node$1[], knownIds?: Record<string, number>): void;
 export declare function isReferencedIdentifier(id: Identifier, parent: Node$1 | null, parentStack: Node$1[]): boolean;
@@ -977,13 +984,16 @@ export declare const noopDirectiveTransform: DirectiveTransform;
 
 export declare function processIf(node: ElementNode, dir: DirectiveNode, context: TransformContext, processCodegen?: (node: IfNode, branch: IfBranchNode, isRoot: boolean) => (() => void) | undefined): (() => void) | undefined;
 
+export declare function processFor(node: ElementNode, dir: DirectiveNode, context: TransformContext, processCodegen?: (forNode: ForNode) => (() => void) | undefined): (() => void) | undefined;
+export declare function createForLoopParams({ value, key, index }: ForParseResult, memoArgs?: ExpressionNode[]): ExpressionNode[];
+
 export declare const transformExpression: NodeTransform;
 export declare function processExpression(node: SimpleExpressionNode, context: TransformContext, asParams?: boolean, asRawStatements?: boolean, localVars?: Record<string, number>): ExpressionNode;
 export declare function stringifyExpression(exp: ExpressionNode | string): string;
 
 export declare const trackSlotScopes: NodeTransform;
 export declare const trackVForSlotScopes: NodeTransform;
-export type SlotFnBuilder = (slotProps: ExpressionNode | undefined, vForExp: ExpressionNode | undefined, slotChildren: TemplateChildNode[], loc: SourceLocation) => FunctionExpression;
+export type SlotFnBuilder = (slotProps: ExpressionNode | undefined, vFor: DirectiveNode | undefined, slotChildren: TemplateChildNode[], loc: SourceLocation) => FunctionExpression;
 export declare function buildSlots(node: ElementNode, context: TransformContext, buildSlotFn?: SlotFnBuilder): {
     slots: SlotsExpression;
     hasDynamicSlots: boolean;