brighterscript 0.66.0-alpha.6 → 0.66.0-alpha.8

package/dist/files/BrsFile.d.ts

@@ -2,7 +2,7 @@ import type { CodeWithSourceMap } from 'source-map';
 import type { CompletionItem, Position, Location, Diagnostic } from 'vscode-languageserver';
 import { DocumentSymbol, SymbolInformation } from 'vscode-languageserver';
 import { FunctionScope } from '../FunctionScope';
-import type { Callable, CommentFlag, FunctionCall, BsDiagnostic, FileReference, FileLink, BscFile } from '../interfaces';
+import type { Callable, CommentFlag, FunctionCall, BsDiagnostic, FileReference, FileLink, SerializedCodeFile, NamespaceContainer } from '../interfaces';
 import type { Token } from '../lexer/Token';
 import { TokenKind } from '../lexer/TokenKind';
 import { Parser, ParseMode } from '../parser/Parser';
@@ -10,28 +10,54 @@ import type { FunctionExpression } from '../parser/Expression';
 import type { ClassStatement, NamespaceStatement, MethodStatement } from '../parser/Statement';
 import type { Program } from '../Program';
 import type { DependencyGraph } from '../DependencyGraph';
-import { type AstNode, type Expression } from '../parser/AstNode';
+import type { AstNode } from '../parser/AstNode';
+import { type Expression } from '../parser/AstNode';
+import type { BscSymbol } from '../SymbolTable';
+import { SymbolTypeFlag } from '../SymbolTable';
+import type { File } from './File';
+import { Editor } from '../astUtils/Editor';
+import type { UnresolvedSymbol } from '../AstValidationSegmenter';
+import { AstValidationSegmenter } from '../AstValidationSegmenter';
+export declare type ProvidedSymbolMap = Map<SymbolTypeFlag, Map<string, BscSymbol>>;
+export declare type ChangedSymbolMap = Map<SymbolTypeFlag, Set<string>>;
+export interface ProvidedSymbolInfo {
+    symbolMap: ProvidedSymbolMap;
+    changes: ChangedSymbolMap;
+}
 /**
  * Holds all details about this file within the scope of the whole program
  */
-export declare class BrsFile {
+export declare class BrsFile implements File {
+    constructor(options: {
+        /**
+         * The path to the file in its source location (where the source code lives in the file system)
+         */
+        srcPath: string;
+        /**
+         * The path to the file where it should exist in the program. This is similar to pkgPath, but retains its original file extensions from srcPath
+         */
+        destPath: string;
+        /**
+         * The final path in the zip. This has the extensions changed. Typically this is the same as destPath, but with file extensions changed for transpiled files.
+         */
+        pkgPath?: string;
+        program: Program;
+    });
+    type: string;
     srcPath: string;
-    /**
-     * The full pkg path to this file
-     */
+    destPath: string;
     pkgPath: string;
     program: Program;
-    constructor(srcPath: string, 
     /**
-     * The full pkg path to this file
+     * An editor assigned during the build flow that manages edits that will be undone once the build process is complete.
      */
-    pkgPath: string, program: Program);
+    editor?: Editor;
     /**
      * The parseMode used for the parser for this file
      */
     parseMode: ParseMode;
     /**
-     * The key used to identify this file in the dependency graph
+     * The key used to identify this file in the dependency graph. This is set by the BrighterScript program and should not be set by plugins
      */
     dependencyGraphKey: string;
     /**
@@ -47,9 +73,12 @@ export declare class BrsFile {
      * A collection of diagnostics related to this file
      */
     diagnostics: BsDiagnostic[];
+    /**
+     * @deprecated use `.diagnostics` instead
+     */
     getDiagnostics(): BsDiagnostic[];
     addDiagnostic(diagnostic: Diagnostic & {
-        file?: BscFile;
+        file?: File;
     }): void;
     addDiagnostics(diagnostics: BsDiagnostic[]): void;
     commentFlags: CommentFlag[];
@@ -64,8 +93,11 @@ export declare class BrsFile {
     get ownScriptImports(): FileReference[];
     /**
      * Does this file need to be transpiled?
+     * @deprecated use the `.editor` property to push changes to the file, which will force transpilation
      */
-    needsTranspiled: boolean;
+    get needsTranspiled(): boolean;
+    set needsTranspiled(value: boolean);
+    _needsTranspiled: boolean;
     /**
      * The AST for this file
      */
@@ -100,19 +132,21 @@ export declare class BrsFile {
      * A reference to the typedef file (if one exists)
      */
     typedefFile?: BrsFile;
-    /**
-     * An unsubscribe function for the dependencyGraph subscription
-     */
-    private unsubscribeFromDependencyGraph;
     /**
      * Find and set the typedef variables (if a matching typedef file exists)
      */
     private resolveTypedef;
+    onDependenciesChanged(): void;
     /**
      * Attach the file to the dependency graph so it can monitor changes.
      * Also notify the dependency graph of our current dependencies so other dependents can be notified.
+     * @deprecated this does nothing. This functionality is now handled by the file api and will be deleted in v1
      */
     attachDependencyGraph(dependencyGraph: DependencyGraph): void;
+    /**
+     * The list of files that this file depends on
+     */
+    get dependencies(): string[];
     /**
      * Calculate the AST for this file
      * @param fileContents the raw source code to parse
@@ -199,10 +233,26 @@ export declare class BrsFile {
     getClassMemberDefinitions(textToSearchFor: string, file: BrsFile): Location[];
     getClassMethod(classStatement: ClassStatement, name: string, walkParents?: boolean): MethodStatement | undefined;
     getReferences(position: Position): Location[];
+    /**
+     * Generate the code, map, and typedef for this file
+     */
+    serialize(): SerializedCodeFile;
     /**
      * Convert the brightscript/brighterscript source code into valid brightscript
      */
     transpile(): CodeWithSourceMap;
+    validationSegmenter: AstValidationSegmenter;
+    processSymbolInformation(): void;
+    getValidationSegments(changedSymbols: Map<SymbolTypeFlag, Set<string>>): AstNode[];
+    get requiredSymbols(): UnresolvedSymbol[];
+    get providedSymbols(): {
+        symbolMap: Map<SymbolTypeFlag, Map<string, BscSymbol>>;
+        changes: Map<SymbolTypeFlag, Set<string>>;
+    };
+    private getProvidedSymbols;
+    markSegmentAsValidated(node: AstNode): void;
+    getNamespaceLookupObject(): Map<string, NamespaceContainer>;
+    private buildNamespaceLookup;
     getTypedef(): string;
     dispose(): void;
 }