source_map_utils.d.ts 3.42 KB
/// <amd-module name="tsickle/src/source_map_utils" />
/**
 * @license
 * Copyright Google Inc. All Rights Reserved.
 *
 * Use of this source code is governed by an MIT-style license that can be
 * found in the LICENSE file at https://angular.io/license
 */
import { RawSourceMap, SourceMapConsumer, SourceMapGenerator } from 'source-map';
import * as ts from './typescript';
/**
 * This interface was defined in @types/source-map but is absent from the typings
 * distributed in the source-map package.
 * Copied from https://unpkg.com/@types/source-map@0.5.2/index.d.ts
 * see https://github.com/angular/tsickle/issues/750
 */
export interface BasicSourceMapConsumer extends SourceMapConsumer {
    file: string;
    sourceRoot: string;
    sources: string[];
    sourcesContent: string[];
}
/**
 * The toJSON method is introduced in
 * https://github.com/mozilla/source-map/commit/7c06ac83dd6d75e65f71727184a2d8630a15bf58#diff-7945f6bb445d956794564e098ef20bb3
 * However there is a breaking change in 0.7.
 * see https://github.com/angular/tsickle/issues/750
 */
export declare type SourceMapGeneratorToJson = SourceMapGenerator & {
    toJSON(): RawSourceMap;
};
export declare function containsInlineSourceMap(source: string): boolean;
export declare function getInlineSourceMapCount(source: string): number;
export declare function extractInlineSourceMap(source: string): string;
export declare function removeInlineSourceMap(source: string): string;
/**
 * Sets the source map inline in the file.  If there's an existing inline source
 * map, it clobbers it.
 */
export declare function setInlineSourceMap(source: string, sourceMap: string): string;
export declare function parseSourceMap(text: string, fileName?: string, sourceName?: string): RawSourceMap;
export declare function sourceMapConsumerToGenerator(sourceMapConsumer: SourceMapConsumer): SourceMapGenerator;
/**
 * Tsc identifies source files by their relative path to the output file.  Since
 * there's no easy way to identify these relative paths when tsickle generates its
 * own source maps, we patch them with the file name from the tsc source maps
 * before composing them.
 */
export declare function sourceMapGeneratorToConsumer(sourceMapGenerator: SourceMapGenerator, fileName?: string, sourceName?: string): SourceMapConsumer;
export declare function sourceMapTextToConsumer(sourceMapText: string): BasicSourceMapConsumer;
export declare function sourceMapTextToGenerator(sourceMapText: string): SourceMapGenerator;
/**
 * A position in a source map. All offsets are zero-based.
 */
export interface SourcePosition {
    /** 0 based */
    column: number;
    /** 0 based */
    line: number;
    /** 0 based full offset in the file. */
    position: number;
}
export interface SourceMapper {
    /**
     * Logically shift all source positions by `offset`.
     *
     * This method is useful if code has to prepend additional text to the generated output after
     * source mappings have already been generated. The source maps are then transparently adjusted
     * during TypeScript output generation.
     */
    shiftByOffset(offset: number): void;
    /**
     * Adds a mapping from `originalNode` in `original` position to its new location in the output,
     * spanning from `generated` (an offset in the file) for `length` characters.
     */
    addMapping(originalNode: ts.Node, original: SourcePosition, generated: SourcePosition, length: number): void;
}
export declare const NOOP_SOURCE_MAPPER: SourceMapper;