@srcmap/codec 0.1.2 → 0.1.3

package/README.md

@@ -0,0 +1,67 @@
+# @srcmap/codec
+
+[![npm](https://img.shields.io/npm/v/@srcmap/codec.svg)](https://www.npmjs.com/package/@srcmap/codec)
+[![CI](https://github.com/BartWaardenburg/srcmap/actions/workflows/ci.yml/badge.svg)](https://github.com/BartWaardenburg/srcmap/actions/workflows/ci.yml)
+[![Coverage](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/BartWaardenburg/srcmap/badges/coverage.json)](https://github.com/BartWaardenburg/srcmap/actions/workflows/coverage.yml)
+
+High-performance VLQ source map codec powered by Rust via [NAPI](https://napi.rs).
+
+Drop-in replacement for [`@jridgewell/sourcemap-codec`](https://github.com/jridgewell/sourcemap-codec). Encodes and decodes source map `mappings` strings as specified in [ECMA-426](https://tc39.es/ecma426/).
+
+## Install
+
+```bash
+npm install @srcmap/codec
+```
+
+Prebuilt binaries are available for:
+- macOS (x64, arm64)
+- Linux (x64, arm64, glibc + musl)
+- Windows (x64)
+
+## Usage
+
+```js
+import { decode, encode } from '@srcmap/codec';
+
+const decoded = decode('AAAA;AACA,EAAE');
+// [
+//   [[0, 0, 0, 0]],
+//   [[0, 0, 1, 0], [2, 0, 0, 2]]
+// ]
+
+const encoded = encode(decoded);
+// 'AAAA;AACA,EAAE'
+```
+
+## API
+
+### `decode(mappings: string): number[][][]`
+
+Decode a VLQ-encoded mappings string into an array of lines, each containing an array of segments. Each segment is an array of 1, 4, or 5 numbers.
+
+### `encode(mappings: number[][][]): string`
+
+Encode decoded mappings back into a VLQ string.
+
+### Segment format
+
+| Fields | Meaning |
+|--------|---------|
+| `[genCol]` | Generated column only |
+| `[genCol, srcIdx, origLine, origCol]` | With source mapping |
+| `[genCol, srcIdx, origLine, origCol, nameIdx]` | With source mapping and name |
+
+## Compatibility
+
+API-compatible with `@jridgewell/sourcemap-codec` — same function signatures, same output format. Can be used as a drop-in replacement.
+
+## Part of [srcmap](https://github.com/BartWaardenburg/srcmap)
+
+High-performance source map tooling written in Rust. See also:
+- [`@srcmap/sourcemap`](https://www.npmjs.com/package/@srcmap/sourcemap) - Source map parser (NAPI)
+- [`@srcmap/sourcemap-wasm`](https://www.npmjs.com/package/@srcmap/sourcemap-wasm) - Source map parser (WASM)
+
+## License
+
+MIT

package/index.d.ts

@@ -0,0 +1,19 @@
+/**
+ * Decode a VLQ-encoded source map mappings string.
+ *
+ * Returns an array of lines, each containing an array of segments.
+ * Each segment is an array of 1, 4, or 5 numbers.
+ *
+ * Compatible with `@jridgewell/sourcemap-codec` decode().
+ */
+export declare function decode(mappings: string): number[][][]
+
+/**
+ * Encode decoded source map mappings back into a VLQ string.
+ *
+ * Takes an array of lines, each containing an array of segments.
+ * Each segment should be an array of 1, 4, or 5 numbers.
+ *
+ * Compatible with `@jridgewell/sourcemap-codec` encode().
+ */
+export declare function encode(mappings: number[][][]): string

package/index.js

@@ -0,0 +1,112 @@
+/* auto-generated NAPI-RS loader */
+const { existsSync, readFileSync } = require('fs')
+const { join } = require('path')
+const { platform, arch } = process
+
+let nativeBinding = null
+
+const triples = {
+  'darwin-arm64': 'srcmap-codec.darwin-arm64.node',
+  'darwin-x64': 'srcmap-codec.darwin-x64.node',
+  'linux-x64-gnu': 'srcmap-codec.linux-x64-gnu.node',
+  'linux-x64-musl': 'srcmap-codec.linux-x64-musl.node',
+  'linux-arm64-gnu': 'srcmap-codec.linux-arm64-gnu.node',
+  'linux-arm64-musl': 'srcmap-codec.linux-arm64-musl.node',
+  'win32-x64-msvc': 'srcmap-codec.win32-x64-msvc.node',
+}
+
+function getTripleKey() {
+  const platformArch = `${platform}-${arch}`
+  if (platform === 'linux') {
+    const { familySync } = require('detect-libc')
+    const libc = familySync() === 'musl' ? 'musl' : 'gnu'
+    return `${platformArch}-${libc}`
+  }
+  return platformArch
+}
+
+const tripleKey = getTripleKey()
+const bindingFile = triples[tripleKey]
+
+if (bindingFile) {
+  const bindingPath = join(__dirname, bindingFile)
+  if (existsSync(bindingPath)) {
+    nativeBinding = require(bindingPath)
+  } else {
+    try {
+      nativeBinding = require(`@srcmap/codec-${tripleKey}`)
+    } catch {
+      throw new Error(`Failed to load native binding for ${tripleKey}. File not found: ${bindingPath}`)
+    }
+  }
+} else {
+  throw new Error(`Unsupported platform: ${tripleKey}`)
+}
+
+module.exports.decode = nativeBinding.decode
+module.exports.encode = nativeBinding.encode
+
+// Experimental: JSON string approach
+module.exports.decodeJson = function decodeJson(mappings) {
+  return JSON.parse(nativeBinding.decodeJson(mappings))
+}
+module.exports.encodeJson = function encodeJson(mappings) {
+  return nativeBinding.encodeJson(JSON.stringify(mappings))
+}
+
+// Experimental: Packed buffer approach
+module.exports.decodeBuf = function decodeBuf(mappings) {
+  const buf = nativeBinding.decodeBuf(mappings)
+  const i32 = new Int32Array(buf.buffer, buf.byteOffset, buf.byteLength >> 2)
+  let pos = 0
+
+  const nLines = i32[pos++]
+  const lineSegCounts = new Array(nLines)
+  for (let i = 0; i < nLines; i++) {
+    lineSegCounts[i] = i32[pos++]
+  }
+
+  const result = new Array(nLines)
+  for (let i = 0; i < nLines; i++) {
+    const nSegs = lineSegCounts[i]
+    const line = new Array(nSegs)
+    for (let j = 0; j < nSegs; j++) {
+      const nFields = i32[pos++]
+      const seg = new Array(nFields)
+      for (let k = 0; k < nFields; k++) {
+        seg[k] = i32[pos++]
+      }
+      line[j] = seg
+    }
+    result[i] = line
+  }
+  return result
+}
+module.exports.encodeBuf = function encodeBuf(mappings) {
+  // Pack nested arrays into flat i32 buffer
+  let totalInts = 1 + mappings.length // n_lines + seg counts
+  for (const line of mappings) {
+    for (const seg of line) {
+      totalInts += 1 + seg.length // n_fields + values
+    }
+  }
+
+  const buf = Buffer.alloc(totalInts * 4)
+  const i32 = new Int32Array(buf.buffer, buf.byteOffset, totalInts)
+  let pos = 0
+
+  i32[pos++] = mappings.length
+  for (const line of mappings) {
+    i32[pos++] = line.length
+  }
+  for (const line of mappings) {
+    for (const seg of line) {
+      i32[pos++] = seg.length
+      for (const val of seg) {
+        i32[pos++] = val
+      }
+    }
+  }
+
+  return nativeBinding.encodeBuf(buf)
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@srcmap/codec",
-  "version": "0.1.2",
+  "version": "0.1.3",
   "description": "High-performance VLQ source map codec powered by Rust",
   "main": "index.js",
   "types": "index.d.ts",
@@ -26,16 +26,17 @@
   "license": "MIT",
   "files": [
     "index.js",
-    "index.d.ts"
+    "index.d.ts",
+    "README.md"
   ],
   "optionalDependencies": {
-    "@srcmap/codec-darwin-x64": "0.1.2",
-    "@srcmap/codec-darwin-arm64": "0.1.2",
-    "@srcmap/codec-linux-x64-gnu": "0.1.2",
-    "@srcmap/codec-linux-x64-musl": "0.1.2",
-    "@srcmap/codec-linux-arm64-gnu": "0.1.2",
-    "@srcmap/codec-linux-arm64-musl": "0.1.2",
-    "@srcmap/codec-win32-x64-msvc": "0.1.2"
+    "@srcmap/codec-darwin-x64": "0.1.3",
+    "@srcmap/codec-darwin-arm64": "0.1.3",
+    "@srcmap/codec-linux-x64-gnu": "0.1.3",
+    "@srcmap/codec-linux-x64-musl": "0.1.3",
+    "@srcmap/codec-linux-arm64-gnu": "0.1.3",
+    "@srcmap/codec-linux-arm64-musl": "0.1.3",
+    "@srcmap/codec-win32-x64-msvc": "0.1.3"
   },
   "devDependencies": {
     "@napi-rs/cli": "^3.0.0"
@@ -44,12 +45,14 @@
     "artifacts": "napi artifacts",
     "build": "napi build --release --platform",
     "build:debug": "napi build --platform",
+    "test": "node --test __tests__/codec.test.mjs",
+    "test:coverage": "mkdir -p coverage && node --test --experimental-test-coverage --test-reporter=lcov --test-reporter-destination=coverage/lcov.info --test-reporter=spec --test-reporter-destination=stdout __tests__/codec.test.mjs",
     "prepublishOnly": "napi prepublish -t npm",
     "version": "napi version"
   },
   "repository": {
     "type": "git",
-    "url": "https://github.com/BartWaardenburg/srcmap"
+    "url": "git+https://github.com/BartWaardenburg/srcmap.git"
   },
   "keywords": [
     "sourcemap",