@jay-framework/compiler-jay-html 0.8.0 → 0.10.0

package/dist/index.d.cts

@@ -1,48 +1,14 @@
-import { CompilerSourceFile, SourceFileFormat, JayType, RefsTree, JayImportLink, WithValidations, MainRuntimeModes, JayEnumType, GenerateTarget, Imports } from '@jay-framework/compiler-shared';
+import { JayType, WithValidations, PluginComponentResolution, JayEnumType, RefsTree, CompilerSourceFile, SourceFileFormat, JayImportLink, MainRuntimeModes, GenerateTarget, Imports } from '@jay-framework/compiler-shared';
 import { HTMLElement } from 'node-html-parser';
 import { ResolveTsConfigOptions } from '@jay-framework/compiler-analyze-exported-types';
 
-interface JayHtmlNamespace {
-    prefix: string;
-    namespace: string;
-}
-interface JayHeadlessImports {
-    key: string;
-    refs: RefsTree;
-    rootType: JayType;
-    contractLinks: JayImportLink[];
-    codeLink: JayImportLink;
-}
-interface JayHtmlHeadLink {
-    rel: string;
-    href: string;
-    attributes: Record<string, string>;
-}
-interface JayHtmlSourceFile extends CompilerSourceFile {
-    format: SourceFileFormat.JayHtml;
-    baseElementName: string;
-    types: JayType;
-    body: HTMLElement;
-    namespaces: JayHtmlNamespace[];
-    headlessImports: JayHeadlessImports[];
-    headLinks: JayHtmlHeadLink[];
-    css?: string;
-    filename?: string;
-}
-
-declare function generateElementDefinitionFile(parsedFile: WithValidations<JayHtmlSourceFile>): WithValidations<string>;
-declare function generateElementFile(jayFile: JayHtmlSourceFile, importerMode: MainRuntimeModes): WithValidations<string>;
-declare function generateElementBridgeFile(jayFile: JayHtmlSourceFile): string;
-declare function generateSandboxRootFile(jayFile: JayHtmlSourceFile): string;
-
-declare function generateElementFileReactTarget(jayFile: JayHtmlSourceFile, importerMode: MainRuntimeModes): WithValidations<string>;
-
 declare enum ContractTagType {
     data = 0,
     interactive = 1,
     variant = 2,
     subContract = 3
 }
+type RenderingPhase = 'slow' | 'fast' | 'fast+interactive';
 interface ContractTag {
     tag: string;
     required?: boolean;
@@ -52,8 +18,10 @@ interface ContractTag {
     description?: Array<string>;
     tags?: Array<ContractTag>;
     repeated?: boolean;
+    trackBy?: string;
     link?: string;
     async?: boolean;
+    phase?: RenderingPhase;
 }
 interface Contract {
     name: string;
@@ -64,6 +32,14 @@ declare function compileContract(contractWithValidations: WithValidations<Contra
 
 declare function parseContract(contractYaml: string, fileName: string): WithValidations<Contract>;
 
+interface JayImportResolver {
+    resolveLink(importingModuleDir: string, link: string): string;
+    loadContract(fullPath: string): WithValidations<Contract>;
+    analyzeExportedTypes(fullPath: string, options: ResolveTsConfigOptions): JayType[];
+    resolvePluginComponent(pluginName: string, contractName: string, projectRoot: string): WithValidations<PluginComponentResolution>;
+}
+declare const JAY_IMPORT_RESOLVER: JayImportResolver;
+
 interface JayContractImportLink {
     module: string;
     viewState: string;
@@ -81,15 +57,70 @@ interface SubContractTraverseResult {
     enumsToImport: EnumToImport[];
 }
 declare function contractToImportsViewStateAndRefs(contract: Contract, contractFilePath: string, jayImportResolver: JayImportResolver, isRepeated?: boolean, isAsync?: boolean): Promise<WithValidations<SubContractTraverseResult>>;
+/**
+ * Generate phase-specific ViewState type
+ */
+declare function contractToPhaseViewState(contract: Contract, contractFilePath: string, jayImportResolver: JayImportResolver, phase: RenderingPhase, isRepeated?: boolean, isAsync?: boolean): Promise<WithValidations<SubContractTraverseResult>>;
+interface PhaseViewStates {
+    slow: SubContractTraverseResult;
+    fast: SubContractTraverseResult;
+    interactive: SubContractTraverseResult;
+}
+/**
+ * Generate all three phase-specific ViewState types
+ */
+declare function contractToAllPhaseViewStates(contract: Contract, contractFilePath: string, jayImportResolver: JayImportResolver): Promise<WithValidations<PhaseViewStates>>;
 
-interface JayImportResolver {
-    resolveLink(importingModuleDir: string, link: string): string;
-    loadContract(fullPath: string): WithValidations<Contract>;
-    analyzeExportedTypes(fullPath: string, options: ResolveTsConfigOptions): JayType[];
+interface JayHtmlNamespace {
+    prefix: string;
+    namespace: string;
 }
-declare const JAY_IMPORT_RESOLVER: JayImportResolver;
+interface JayHeadlessImports {
+    key: string;
+    refs: RefsTree;
+    rootType: JayType;
+    contractLinks: JayImportLink[];
+    codeLink: JayImportLink;
+    contract?: Contract;
+}
+interface JayHtmlHeadLink {
+    rel: string;
+    href: string;
+    attributes: Record<string, string>;
+}
+interface JayHtmlSourceFile extends CompilerSourceFile {
+    format: SourceFileFormat.JayHtml;
+    baseElementName: string;
+    types: JayType;
+    body: HTMLElement;
+    namespaces: JayHtmlNamespace[];
+    headlessImports: JayHeadlessImports[];
+    headLinks: JayHtmlHeadLink[];
+    css?: string;
+    filename?: string;
+    contract?: Contract;
+    contractRef?: string;
+    hasInlineData?: boolean;
+    /**
+     * TrackBy map for server-side merge (slow → fast).
+     * Includes all tracked arrays.
+     */
+    serverTrackByMap?: Record<string, string>;
+    /**
+     * TrackBy map for client-side merge (fast → interactive).
+     * Excludes arrays with phase 'fast+interactive' (dynamic arrays that can be fully replaced).
+     */
+    clientTrackByMap?: Record<string, string>;
+}
+
+declare function generateElementDefinitionFile(parsedFile: WithValidations<JayHtmlSourceFile>): WithValidations<string>;
+declare function generateElementFile(jayFile: JayHtmlSourceFile, importerMode: MainRuntimeModes): WithValidations<string>;
+declare function generateElementBridgeFile(jayFile: JayHtmlSourceFile): string;
+declare function generateSandboxRootFile(jayFile: JayHtmlSourceFile): string;
+
+declare function generateElementFileReactTarget(jayFile: JayHtmlSourceFile, importerMode: MainRuntimeModes): WithValidations<string>;
 
-declare function parseJayFile(html: string, filename: string, filePath: string, options: ResolveTsConfigOptions, linkedContractResolver: JayImportResolver): Promise<WithValidations<JayHtmlSourceFile>>;
+declare function parseJayFile(html: string, filename: string, filePath: string, options: ResolveTsConfigOptions, linkedContractResolver: JayImportResolver, projectRoot: string): Promise<WithValidations<JayHtmlSourceFile>>;
 declare function getJayHtmlImports(html: string): string[];
 
 declare function parseIsEnum(expression: string): boolean;
@@ -102,4 +133,4 @@ declare function renderRefsType(refs: RefsTree, refsType: string, generateTarget
 
 declare function generateTypes(types: JayType): string;
 
-export { type Contract, type ContractTag, ContractTagType, type EnumToImport, JAY_IMPORT_RESOLVER, type JayContractImportLink, type JayHtmlSourceFile, type JayImportResolver, compileContract, contractToImportsViewStateAndRefs, generateElementBridgeFile, generateElementDefinitionFile, generateElementFile, generateElementFileReactTarget, generateSandboxRootFile, generateTypes, getJayHtmlImports, parseContract, parseEnumValues, parseIsEnum, parseJayFile, renderRefsType };
+export { type Contract, type ContractTag, ContractTagType, type EnumToImport, JAY_IMPORT_RESOLVER, type JayContractImportLink, type JayHtmlSourceFile, type JayImportResolver, type PhaseViewStates, type RenderingPhase, compileContract, contractToAllPhaseViewStates, contractToImportsViewStateAndRefs, contractToPhaseViewState, generateElementBridgeFile, generateElementDefinitionFile, generateElementFile, generateElementFileReactTarget, generateSandboxRootFile, generateTypes, getJayHtmlImports, parseContract, parseEnumValues, parseIsEnum, parseJayFile, renderRefsType };