@backtrace/sourcemap-tools
Version:
Backtrace-JavaScript sourcemap tools
47 lines (46 loc) • 2.18 kB
TypeScript
import { RawSourceMap } from 'source-map';
import { SymbolUploaderOptions, UploadResult } from '../SymbolUploader';
import { Asset, AssetWithContent } from '../models/Asset';
import { ProcessAssetError, ProcessAssetResult } from '../models/ProcessAssetResult';
import { Result } from '../models/Result';
interface BacktracePluginUploadOptions {
/**
* By default, `sourcesContent` in sourcemaps will not be uploaded to Backtrace, even if available in the sourcemap.
* Set this to `true` to upload sourcemaps with `sourcesContent` if available.
*/
readonly includeSources: boolean;
}
export interface BacktracePluginOptions {
/**
* Upload URL for uploading sourcemap files.
* See Source Maps Integration Guide for your instance for more information.
*
* If not set, the sourcemaps will not be uploaded. The sources will be still processed and ready for manual upload.
*/
readonly uploadUrl?: string | URL;
/**
* Additional upload options.
*/
readonly uploadOptions?: SymbolUploaderOptions & BacktracePluginUploadOptions;
}
interface ProcessResult {
readonly assetResults: Result<ProcessAssetResult, ProcessAssetError>[];
readonly uploadResult?: Result<UploadResult, string>;
}
export interface ProcessAndUploadAssetsCommandOptions {
beforeAll?(assets: Asset[]): unknown;
afterAll?(result: ProcessResult): unknown;
beforeProcess?(asset: Asset): unknown;
afterProcess?(asset: ProcessAssetResult): unknown;
beforeWrite?(asset: ProcessAssetResult): unknown;
afterWrite?(asset: ProcessAssetResult): unknown;
assetFinished?(asset: ProcessAssetResult): unknown;
beforeLoad?(asset: Asset): unknown;
afterLoad?(asset: AssetWithContent<RawSourceMap>): unknown;
beforeUpload?(assets: AssetWithContent<RawSourceMap>[]): unknown;
afterUpload?(result: UploadResult): unknown;
assetError?(error: ProcessAssetError): unknown;
uploadError?(error: string): unknown;
}
export declare function processAndUploadAssetsCommand(pluginOptions: BacktracePluginOptions, options?: ProcessAndUploadAssetsCommandOptions): (assets: Asset[]) => Promise<ProcessResult>;
export {};