@atlaspack/source-map 3.0.1-canary.4070

package/dist/utils.js

@@ -0,0 +1,59 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.generateInlineMap = generateInlineMap;
+exports.partialVlqMapToSourceMap = partialVlqMapToSourceMap;
+const path_1 = __importDefault(require("path"));
+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_1.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/lib/SourceMap.js

@@ -0,0 +1,421 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = exports.SOURCE_MAP_VERSION = void 0;
+var _utils = require("./utils");
+var _package = require("../package.json");
+const SOURCE_MAP_VERSION = exports.SOURCE_MAP_VERSION = `atlaspack:${_package.version}`;
+class SourceMap {
+  /**
+   * @private
+   */
+
+  /**
+   * @private
+   */
+
+  /**
+   * 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 = '/', buffer) {
+    this.projectRoot = projectRoot;
+  }
+
+  // Use this to invalidate saved buffers, we don't check versioning at all in Rust
+  get libraryVersion() {
+    return SOURCE_MAP_VERSION;
+  }
+
+  /**
+   * 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 = 0
+  }) {
+    throw new Error('SourceMap.generateEmptyMap() must be implemented when extending 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, sourceContent, lineOffset = 0) {
+    this.sourceMapInstance.addEmptyMap(sourceName, sourceContent, lineOffset);
+    return this;
+  }
+
+  /**
+   * Appends raw VLQ mappings to the sourcemaps
+   */
+  addVLQMap(map, lineOffset = 0, columnOffset = 0) {
+    throw new Error('SourceMap.addVLQMap() must be implemented when extending 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, lineOffset = 0) {
+    throw new Error('Not implemented by child class');
+  }
+
+  /**
+   * 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, lineOffset = 0) {
+    throw new Error('Not implemented by child class');
+  }
+
+  /**
+   * 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, lineOffset = 0, columnOffset = 0) {
+    // Not sure if it'll be worth it to add this back to C++, wrapping it in an array probably doesn't do that much harm in JS?
+    // Also we barely use this function anyway...
+    this.addIndexedMappings([mapping], lineOffset, columnOffset);
+  }
+  _indexedMappingsToInt32Array(mappings, lineOffset = 0, columnOffset = 0) {
+    // Encode all mappings into a single typed array and make one call
+    // to C++ instead of one for each mapping to improve performance.
+    let mappingBuffer = new Int32Array(mappings.length * 6);
+    let sources = new Map();
+    let names = new Map();
+    let i = 0;
+    for (let mapping of mappings) {
+      let hasValidOriginal = mapping.original !== undefined && typeof mapping.original.line === 'number' && !Number.isNaN(mapping.original.line) && typeof mapping.original.column === 'number' && !Number.isNaN(mapping.original.column);
+      mappingBuffer[i++] = mapping.generated.line + lineOffset - 1;
+      mappingBuffer[i++] = mapping.generated.column + columnOffset;
+      // @ts-expect-error TS18048
+      mappingBuffer[i++] = hasValidOriginal ? mapping.original.line - 1 : -1;
+      // @ts-expect-error TS18048
+      mappingBuffer[i++] = hasValidOriginal ? mapping.original.column : -1;
+      let sourceIndex = mapping.source ? sources.get(mapping.source) : -1;
+      if (sourceIndex == null && mapping.source) {
+        sourceIndex = this.addSource(mapping.source);
+        sources.set(mapping.source, sourceIndex);
+      }
+      // @ts-expect-error TS18048
+      mappingBuffer[i++] = sourceIndex;
+      let nameIndex = mapping.name ? names.get(mapping.name) : -1;
+      if (nameIndex == null && mapping.name) {
+        nameIndex = this.addName(mapping.name);
+        names.set(mapping.name, nameIndex);
+      }
+      // @ts-expect-error TS18048
+      mappingBuffer[i++] = nameIndex;
+    }
+    return mappingBuffer;
+  }
+
+  /**
+   * 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, lineOffset = 0, columnOffset = 0) {
+    let mappingBuffer = this._indexedMappingsToInt32Array(mappings, lineOffset, columnOffset);
+    this.sourceMapInstance.addIndexedMappings(mappingBuffer);
+    return this;
+  }
+
+  /**
+   * 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) {
+    return this.sourceMapInstance.addName(name);
+  }
+
+  /**
+   * 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) {
+    return names.map(n => this.addName(n));
+  }
+
+  /**
+   * 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) {
+    return this.sourceMapInstance.addSource(source);
+  }
+
+  /**
+   * 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) {
+    return sources.map(s => this.addSource(s));
+  }
+
+  /**
+   * Get the index in the sources array for a certain source file filepath
+   *
+   * @param source the filepath of the source file
+   */
+  getSourceIndex(source) {
+    return this.sourceMapInstance.getSourceIndex(source);
+  }
+
+  /**
+   * 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) {
+    return this.sourceMapInstance.getSource(index);
+  }
+
+  /**
+   * Get a list of all sources
+   */
+  getSources() {
+    return this.sourceMapInstance.getSources();
+  }
+
+  /**
+   * 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, sourceContent) {
+    return this.sourceMapInstance.setSourceContentBySource(sourceName, sourceContent);
+  }
+
+  /**
+   * Get the content of a source file if it is inlined as part of the source-map
+   *
+   * @param sourceName filename
+   */
+  getSourceContent(sourceName) {
+    return this.sourceMapInstance.getSourceContentBySource(sourceName);
+  }
+
+  /**
+   * Get a list of all sources
+   */
+  getSourcesContent() {
+    return this.sourceMapInstance.getSourcesContent();
+  }
+
+  /**
+   * Get a map of the source and it's corresponding source content
+   */
+  getSourcesContentMap() {
+    let sources = this.getSources();
+    let sourcesContent = this.getSourcesContent();
+    let results = {};
+    for (let i = 0; i < sources.length; i++) {
+      results[sources[i]] = sourcesContent[i] || null;
+    }
+    return results;
+  }
+
+  /**
+   * Get the index in the names array for a certain name
+   *
+   * @param name the name you want to find the index of
+   */
+  getNameIndex(name) {
+    return this.sourceMapInstance.getNameIndex(name);
+  }
+
+  /**
+   * Get the name for a certain index of the names array
+   *
+   * @param index the index of the name in the names array
+   */
+  getName(index) {
+    return this.sourceMapInstance.getName(index);
+  }
+
+  /**
+   * Get a list of all names
+   */
+  getNames() {
+    return this.sourceMapInstance.getNames();
+  }
+
+  /**
+   * Get a list of all mappings
+   */
+  getMappings() {
+    return this.sourceMapInstance.getMappings();
+  }
+
+  /**
+   * 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) {
+    if (!mapping) return mapping;
+    if (mapping.source != null && mapping.source > -1) {
+      // @ts-expect-error TS2322
+      mapping.source = this.getSource(mapping.source);
+    }
+    if (mapping.name != null && mapping.name > -1) {
+      // @ts-expect-error TS2322
+      mapping.name = this.getName(mapping.name);
+    }
+
+    // @ts-expect-error TS2322
+    return mapping;
+  }
+
+  /**
+   * 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) {
+    throw new Error('Should be implemented by extending');
+  }
+
+  /**
+   * 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() {
+    return {
+      mappings: this.getMappings(),
+      sources: this.getSources(),
+      sourcesContent: this.getSourcesContent(),
+      names: this.getNames()
+    };
+  }
+
+  /**
+   * 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, column) {
+    let mapping = this.sourceMapInstance.findClosestMapping(line - 1, column);
+    if (mapping) {
+      let v = this.indexedMappingToStringMapping(mapping);
+      return v;
+    } else {
+      return 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, lineOffset) {
+    if (line < 1 || line + lineOffset < 1) {
+      throw new Error('Line has to be positive');
+    }
+    if (lineOffset === 0) {
+      return;
+    }
+    this.sourceMapInstance.offsetLines(line - 1, lineOffset);
+  }
+
+  /**
+   * 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, column, columnOffset) {
+    if (line < 1 || column < 0 || column + columnOffset < 0) {
+      throw new Error('Line and Column has to be positive');
+    }
+    if (columnOffset === 0) {
+      return;
+    }
+    this.sourceMapInstance.offsetColumns(line - 1, column, columnOffset);
+  }
+
+  /**
+   * Returns a buffer that represents this sourcemap, used for caching
+   */
+  toBuffer() {
+    return this.sourceMapInstance.toBuffer();
+  }
+
+  /**
+   * Returns a serialised map using VLQ Mappings
+   */
+  toVLQ() {
+    return this.sourceMapInstance.toVLQ();
+  }
+
+  /**
+   * 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() {
+    throw new Error('SourceMap.delete() must be implemented when extending SourceMap');
+  }
+
+  /**
+   * Returns a serialised map
+   *
+   * @param options options used for formatting the serialised map
+   */
+  stringify(options) {
+    return (0, _utils.partialVlqMapToSourceMap)(this.toVLQ(), {
+      ...options,
+      rootDir: this.projectRoot || options.rootDir
+    });
+  }
+}
+exports.default = SourceMap;

package/lib/node.js

@@ -0,0 +1,92 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.init = exports.default = void 0;
+var _SourceMap = _interopRequireWildcard(require("./SourceMap"));
+function _rust() {
+  const data = require("@atlaspack/rust");
+  _rust = function () {
+    return data;
+  };
+  return data;
+}
+function _getRequireWildcardCache(e) { if ("function" != typeof WeakMap) return null; var r = new WeakMap(), t = new WeakMap(); return (_getRequireWildcardCache = function (e) { return e ? t : r; })(e); }
+function _interopRequireWildcard(e, r) { if (!r && e && e.__esModule) return e; if (null === e || "object" != typeof e && "function" != typeof e) return { default: e }; var t = _getRequireWildcardCache(r); if (t && t.has(e)) return t.get(e); var n = { __proto__: null }, a = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var u in e) if ("default" !== u && Object.prototype.hasOwnProperty.call(e, u)) { var i = a ? Object.getOwnPropertyDescriptor(e, u) : null; i && (i.get || i.set) ? Object.defineProperty(n, u, i) : n[u] = e[u]; } return n.default = e, t && t.set(e, n), n; }
+// Re-export types for consumers
+
+class NodeSourceMap extends _SourceMap.default {
+  constructor(projectRoot = '/', buffer) {
+    super(projectRoot);
+    this.projectRoot = projectRoot;
+    this.sourceMapInstance = new (_rust().SourceMap)(projectRoot, buffer);
+  }
+  addVLQMap(map, lineOffset = 0, columnOffset = 0) {
+    let {
+      sourcesContent,
+      sources = [],
+      mappings,
+      names = []
+    } = map;
+    if (!sourcesContent) {
+      sourcesContent = sources.map(() => '');
+    } else {
+      sourcesContent = sourcesContent.map(content => content ? content : '');
+    }
+    this.sourceMapInstance.addVLQMap(mappings, sources, sourcesContent.map(content => content ? content : ''), names, lineOffset, columnOffset);
+    return this;
+  }
+  addSourceMap(sourcemap, lineOffset = 0) {
+    if (!(sourcemap.sourceMapInstance instanceof _rust().SourceMap)) {
+      throw new Error('The sourcemap provided to addSourceMap is not a valid sourcemap instance');
+    }
+    this.sourceMapInstance.addSourceMap(sourcemap.sourceMapInstance, lineOffset);
+    return this;
+  }
+  addBuffer(buffer, lineOffset = 0) {
+    let previousMap = new NodeSourceMap(this.projectRoot, buffer);
+    return this.addSourceMap(previousMap, lineOffset);
+  }
+  extends(input) {
+    // $FlowFixMe
+    let inputSourceMap = Buffer.isBuffer(input) ? new NodeSourceMap(this.projectRoot, input) : input;
+    this.sourceMapInstance.extends(inputSourceMap.sourceMapInstance);
+    return this;
+  }
+  getNames() {
+    return this.sourceMapInstance.getNames();
+  }
+  getSources() {
+    return this.sourceMapInstance.getSources();
+  }
+  delete() {}
+  static generateEmptyMap({
+    projectRoot,
+    sourceName,
+    sourceContent,
+    lineOffset = 0
+  }) {
+    let map = new NodeSourceMap(projectRoot);
+    map.addEmptyMap(sourceName, sourceContent, lineOffset);
+    return map;
+  }
+
+  // This function exists to ensure that source map instances from (for example) @parcel/source-map
+  // are not used in place of @atlaspack/source-map, as from a JS point of view this is fine, but the
+  // underlying buffer may be different, and can cause build time errors.
+  static safeToBuffer(sourceMap) {
+    if (sourceMap == null || sourceMap == undefined) {
+      return undefined;
+    }
+
+    // We can't use instanceof here because if we're using a resolution for @parcel/source-map,
+    // it will be a different instance as it'll be a "copy" of @atlaspack/source-map
+    if (sourceMap.libraryVersion === _SourceMap.SOURCE_MAP_VERSION) {
+      return sourceMap.toBuffer();
+    }
+    throw new Error('Source map is not an Atlaspack SourceMap (Expected version ' + _SourceMap.SOURCE_MAP_VERSION + ', got ' + sourceMap.libraryVersion + ')');
+  }
+}
+exports.default = NodeSourceMap;
+const init = exports.init = Promise.resolve();