@atlaspack/source-map 3.0.1-canary.4070

package/lib/types/SourceMap.d.ts

@@ -0,0 +1,229 @@
+import type { ParsedMap, VLQMap, SourceMapStringifyOptions, IndexedMapping, GenerateEmptyMapOptions } from './types';
+export declare const SOURCE_MAP_VERSION: string;
+export default class SourceMap {
+    /**
+     * @private
+     */
+    sourceMapInstance: any;
+    /**
+     * @private
+     */
+    projectRoot: string;
+    /**
+     * Construct a SourceMap instance
+     *
+     * @param projectRoot root directory of the project, this is to ensure all source paths are relative to this path
+     */
+    constructor(projectRoot?: string, buffer?: Buffer);
+    get libraryVersion(): string;
+    /**
+     * Generates an empty map from the provided fileName and sourceContent
+     *
+     * @param sourceName path of the source file
+     * @param sourceContent content of the source file
+     * @param lineOffset an offset that gets added to the sourceLine index of each mapping
+     */
+    static generateEmptyMap({ projectRoot, sourceName, sourceContent, lineOffset, }: GenerateEmptyMapOptions): SourceMap;
+    /**
+     * Generates an empty map from the provided fileName and sourceContent
+     *
+     * @param sourceName path of the source file
+     * @param sourceContent content of the source file
+     * @param lineOffset an offset that gets added to the sourceLine index of each mapping
+     */
+    addEmptyMap(sourceName: string, sourceContent: string, lineOffset?: number): SourceMap;
+    /**
+     * Appends raw VLQ mappings to the sourcemaps
+     */
+    addVLQMap(map: VLQMap, lineOffset?: number, columnOffset?: number): SourceMap;
+    /**
+     * Appends another sourcemap instance to this sourcemap
+     *
+     * @param buffer the sourcemap buffer that should get appended to this sourcemap
+     * @param lineOffset an offset that gets added to the sourceLine index of each mapping
+     */
+    addSourceMap(sourcemap: SourceMap, lineOffset?: number): SourceMap;
+    /**
+     * Appends a buffer to this sourcemap
+     * Note: The buffer should be generated by this library
+     * @param buffer the sourcemap buffer that should get appended to this sourcemap
+     * @param lineOffset an offset that gets added to the sourceLine index of each mapping
+     */
+    addBuffer(buffer: Buffer, lineOffset?: number): SourceMap;
+    /**
+     * Appends a Mapping object to this sourcemap
+     * Note: line numbers start at 1 due to mozilla's source-map library
+     *
+     * @param mapping the mapping that should be appended to this sourcemap
+     * @param lineOffset an offset that gets added to the sourceLine index of each mapping
+     * @param columnOffset  an offset that gets added to the sourceColumn index of each mapping
+     */
+    addIndexedMapping(mapping: IndexedMapping<string>, lineOffset?: number, columnOffset?: number): void;
+    _indexedMappingsToInt32Array(mappings: Array<IndexedMapping<string>>, lineOffset?: number, columnOffset?: number): Int32Array;
+    /**
+     * Appends an array of Mapping objects to this sourcemap
+     * This is useful when improving performance if a library provides the non-serialised mappings
+     *
+     * Note: This is only faster if they generate the serialised map lazily
+     * Note: line numbers start at 1 due to mozilla's source-map library
+     *
+     * @param mappings an array of mapping objects
+     * @param lineOffset an offset that gets added to the sourceLine index of each mapping
+     * @param columnOffset  an offset that gets added to the sourceColumn index of each mapping
+     */
+    addIndexedMappings(mappings: Array<IndexedMapping<string>>, lineOffset?: number, columnOffset?: number): SourceMap;
+    /**
+     * Appends a name to the sourcemap
+     *
+     * @param name the name that should be appended to the names array
+     * @returns the index of the added name in the names array
+     */
+    addName(name: string): number;
+    /**
+     * Appends an array of names to the sourcemap's names array
+     *
+     * @param names an array of names to add to the sourcemap
+     * @returns an array of indexes of the names in the sourcemap's names array, has the same order as the provided names array
+     */
+    addNames(names: Array<string>): Array<number>;
+    /**
+     * Appends a source to the sourcemap's sources array
+     *
+     * @param source a filepath that should be appended to the sources array
+     * @returns the index of the added source filepath in the sources array
+     */
+    addSource(source: string): number;
+    /**
+     * Appends an array of sources to the sourcemap's sources array
+     *
+     * @param sources an array of filepaths which should sbe appended to the sources array
+     * @returns an array of indexes of the sources that have been added to the sourcemap, returned in the same order as provided in the argument
+     */
+    addSources(sources: Array<string>): Array<number>;
+    /**
+     * Get the index in the sources array for a certain source file filepath
+     *
+     * @param source the filepath of the source file
+     */
+    getSourceIndex(source: string): number;
+    /**
+     * Get the source file filepath for a certain index of the sources array
+     *
+     * @param index the index of the source in the sources array
+     */
+    getSource(index: number): string;
+    /**
+     * Get a list of all sources
+     */
+    getSources(): Array<string>;
+    /**
+     * Set the sourceContent for a certain file
+     * this is optional and is only recommended for files that we cannot read in at the end when we serialise the sourcemap
+     *
+     * @param sourceName the path of the sourceFile
+     * @param sourceContent the content of the sourceFile
+     */
+    setSourceContent(sourceName: string, sourceContent: string): void;
+    /**
+     * Get the content of a source file if it is inlined as part of the source-map
+     *
+     * @param sourceName filename
+     */
+    getSourceContent(sourceName: string): string | null;
+    /**
+     * Get a list of all sources
+     */
+    getSourcesContent(): Array<string | null>;
+    /**
+     * Get a map of the source and it's corresponding source content
+     */
+    getSourcesContentMap(): {
+        [key: string]: string | null;
+    };
+    /**
+     * Get the index in the names array for a certain name
+     *
+     * @param name the name you want to find the index of
+     */
+    getNameIndex(name: string): number;
+    /**
+     * Get the name for a certain index of the names array
+     *
+     * @param index the index of the name in the names array
+     */
+    getName(index: number): string;
+    /**
+     * Get a list of all names
+     */
+    getNames(): Array<string>;
+    /**
+     * Get a list of all mappings
+     */
+    getMappings(): Array<IndexedMapping<number>>;
+    /**
+     * Convert a Mapping object that uses indexes for name and source to the actual value of name and source
+     *
+     * Note: This is only used internally, should not be used externally and will probably eventually get
+     * handled directly in C++ for improved performance
+     *
+     * @param index the Mapping that should get converted to a string-based Mapping
+     */
+    indexedMappingToStringMapping(mapping: IndexedMapping<number>): IndexedMapping<string> | null;
+    /**
+     * Remaps original positions from this map to the ones in the provided map
+     *
+     * This works by finding the closest generated mapping in the provided map
+     * to original mappings of this map and remapping those to be the original
+     * mapping of the provided map.
+     *
+     * @param buffer exported SourceMap as a buffer
+     */
+    extends(buffer: Buffer | SourceMap): SourceMap;
+    /**
+     * Returns an object with mappings, sources and names
+     * This should only be used for tests, debugging and visualising sourcemaps
+     *
+     * Note: This is a fairly slow operation
+     */
+    getMap(): ParsedMap;
+    /**
+     * Searches through the sourcemap and returns a mapping that is close to the provided generated line and column
+     *
+     * @param line the line in the generated code (starts at 1)
+     * @param column the column in the generated code (starts at 0)
+     */
+    findClosestMapping(line: number, column: number): IndexedMapping<string> | null;
+    /**
+     * Offset mapping lines from a certain position
+     *
+     * @param line the line in the generated code (starts at 1)
+     * @param lineOffset the amount of lines to offset mappings by
+     */
+    offsetLines(line: number, lineOffset: number): void;
+    /**
+     * Offset mapping columns from a certain position
+     *
+     * @param line the line in the generated code (starts at 1)
+     * @param column the column in the generated code (starts at 0)
+     * @param columnOffset the amount of columns to offset mappings by
+     */
+    offsetColumns(line: number, column: number, columnOffset: number): void;
+    /**
+     * Returns a buffer that represents this sourcemap, used for caching
+     */
+    toBuffer(): Buffer;
+    /**
+     * Returns a serialised map using VLQ Mappings
+     */
+    toVLQ(): VLQMap;
+    /**
+     * A function that has to be called at the end of the SourceMap's lifecycle to ensure all memory and native bindings get de-allocated
+     */
+    delete(): void;
+    /**
+     * Returns a serialised map
+     *
+     * @param options options used for formatting the serialised map
+     */
+    stringify(options: SourceMapStringifyOptions): Promise<string | VLQMap>;
+}

package/lib/types/node.d.ts

@@ -0,0 +1,17 @@
+import type { VLQMap, GenerateEmptyMapOptions } from './types';
+import SourceMap from './SourceMap';
+export type * from './types';
+export default class NodeSourceMap extends SourceMap {
+    constructor(projectRoot?: string, buffer?: Buffer);
+    addVLQMap(map: VLQMap, lineOffset?: number, columnOffset?: number): SourceMap;
+    addSourceMap(sourcemap: SourceMap, lineOffset?: number): SourceMap;
+    addBuffer(buffer: Buffer, lineOffset?: number): SourceMap;
+    extends(input: Buffer | SourceMap): SourceMap;
+    getNames(): Array<string>;
+    getSources(): Array<string>;
+    delete(): void;
+    static generateEmptyMap({ projectRoot, sourceName, sourceContent, lineOffset, }: GenerateEmptyMapOptions): NodeSourceMap;
+    static safeToBuffer<T extends SourceMap>(sourceMap: T | null | undefined): Buffer | undefined;
+}
+export declare const init: Promise<void>;
+export type { SourceMap };

package/lib/types/types.d.ts

@@ -0,0 +1,44 @@
+export interface MappingPosition {
+    line: number;
+    column: number;
+}
+export interface IndexedMapping<T> {
+    generated: MappingPosition;
+    original?: MappingPosition;
+    source?: T;
+    name?: T;
+}
+export interface ParsedMap {
+    sources: Array<string>;
+    names: Array<string>;
+    mappings: Array<IndexedMapping<number>>;
+    sourcesContent: Array<string | null>;
+}
+export interface VLQMap {
+    sources: readonly string[];
+    sourcesContent?: readonly (string | null)[];
+    names: readonly string[];
+    mappings: string;
+    version?: number;
+    file?: string;
+    sourceRoot?: string;
+}
+export interface SourceMapStringifyOptions {
+    file?: string;
+    sourceRoot?: string;
+    inlineSources?: boolean;
+    fs?: {
+        readFile(path: string, encoding: string): Promise<string>;
+    };
+    format?: 'inline' | 'string' | 'object';
+    /**
+     * @private
+     */
+    rootDir?: string;
+}
+export interface GenerateEmptyMapOptions {
+    projectRoot: string;
+    sourceName: string;
+    sourceContent: string;
+    lineOffset?: number;
+}

package/lib/types/utils.d.ts

@@ -0,0 +1,3 @@
+import type { VLQMap, SourceMapStringifyOptions } from './types';
+export declare function generateInlineMap(map: string): string;
+export declare function partialVlqMapToSourceMap(map: VLQMap, opts: SourceMapStringifyOptions): Promise<VLQMap | string>;

package/lib/types.js

@@ -0,0 +1 @@
+"use strict";

package/lib/utils.js

@@ -0,0 +1,69 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.generateInlineMap = generateInlineMap;
+exports.partialVlqMapToSourceMap = partialVlqMapToSourceMap;
+function _path() {
+  const data = _interopRequireDefault(require("path"));
+  _path = function () {
+    return data;
+  };
+  return data;
+}
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+function generateInlineMap(map) {
+  return `data:application/json;charset=utf-8;base64,${Buffer.from(map).toString('base64')}`;
+}
+async function partialVlqMapToSourceMap(map, opts) {
+  let {
+    fs,
+    file,
+    sourceRoot,
+    inlineSources,
+    rootDir,
+    format = 'string'
+  } = opts;
+  let resultMap = {
+    ...map,
+    sourcesContent: map.sourcesContent ? map.sourcesContent.map(content => {
+      if (content) {
+        return content;
+      } else {
+        return null;
+      }
+    }) : [],
+    version: 3,
+    file,
+    sourceRoot
+  };
+  if (resultMap.sourcesContent.length < resultMap.sources.length) {
+    for (let i = 0; i <= resultMap.sources.length - resultMap.sourcesContent.length; i++) {
+      resultMap.sourcesContent.push(null);
+    }
+  }
+  if (fs) {
+    resultMap.sourcesContent = await Promise.all(resultMap.sourcesContent.map(async (content, index) => {
+      let sourceName = map.sources[index];
+      // If sourceName starts with `..` it is outside rootDir, in this case we likely cannot access this file from the browser or packaged node_module
+      // Because of this we have to include the sourceContent to ensure you can always see the sourcecontent for each mapping.
+      if (!content && (inlineSources || sourceName.startsWith('..'))) {
+        try {
+          return await fs.readFile(_path().default.resolve(rootDir || '/', sourceName), 'utf-8');
+        } catch (e) {
+          /* empty */
+        }
+      }
+      return content;
+    }));
+  }
+  if (format === 'inline' || format === 'string') {
+    let stringifiedMap = JSON.stringify(resultMap);
+    if (format === 'inline') {
+      return generateInlineMap(stringifiedMap);
+    }
+    return stringifiedMap;
+  }
+  return resultMap;
+}

package/package.json

@@ -0,0 +1,27 @@
+{
+  "name": "@atlaspack/source-map",
+  "version": "3.0.1-canary.4070+31c12bc28",
+  "license": "(MIT OR Apache-2.0)",
+  "type": "commonjs",
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/atlassian-labs/atlaspack.git"
+  },
+  "main": "./lib/node.js",
+  "source": "./src/node.ts",
+  "types": "./lib/types/node.d.ts",
+  "engines": {
+    "node": ">= 16.0.0"
+  },
+  "scripts": {
+    "check-ts": "tsc --emitDeclarationOnly --rootDir src",
+    "build:lib": "gulp build --gulpfile ../../../gulpfile.js --cwd ."
+  },
+  "dependencies": {
+    "@atlaspack/rust": "3.2.1-canary.291+31c12bc28"
+  },
+  "gitHead": "31c12bc28d861d4ce80446afffc18cb0c7b4ebd3"
+}