Convert to Typescript (#2)

* Update package.json, add typescript, vitest

* Convert to typescript

* Fix lints

* Prefer function over lambdas, type instead of class, preserve original ordering

* Update tests

* Add rollup

* Get eslint running

* Add CI

* Prepare for onboarding

* Remove old example, add coverage reporting

* fix lint: Use `interface` instead of `type`

* Fix coverage reporting

* Fix comparison, remove comment types

Author: mwilsnd

.circleci/config.yml

@@ -1,3 +1,3 @@
 module.exports = {
-    "extends": "standard"
-};
+  extends: 'standard'
+}

.eslintrc.js

@@ -0,0 +1,2 @@
+github: [maplibre]
+open_collective: maplibre

.github/FUNDING.yml

@@ -0,0 +1,58 @@
+name: Unit Tests
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+
+jobs:
+  build:
+    name: Build and Test
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node-version: [20.x, 22.x]
+        # See supported Node.js release schedule at https://nodejs.org/en/about/releases/
+    steps:
+    - uses: actions/checkout@v4
+      with:
+        submodules: 'recursive'
+    - name: Use Node.js ${{ matrix.node-version }}
+      uses: actions/setup-node@v4
+      with:
+        node-version: ${{ matrix.node-version }}
+        cache: 'npm'
+    - run: npm ci
+    - run: npm run lint
+    - run: npm run build
+    - run: npm run test-unit
+
+  run-tests:
+    name: Generate Coverage
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node-version: [22.x]
+    steps:
+    - uses: actions/checkout@v4
+      with:
+        submodules: 'recursive'
+    - name: Use Node.js ${{ matrix.node-version }}
+      uses: actions/setup-node@v4
+      with:
+        node-version: ${{ matrix.node-version }}
+        cache: 'npm'
+    - run: npm ci
+    - run: npm run test-unit-ci
+    - name: Upload test results to Codecov
+      if: '!cancelled()'
+      uses: codecov/test-results-action@v1
+      with:
+        token: ${{ secrets.CODECOV_TOKEN }}
+    - name: Upload coverage reports to Codecov
+      uses: codecov/codecov-action@v5
+      with:
+        files: ${{ github.workspace }}/coverage/vitest/unit/coverage-final.json
+        verbose: true
+        token: ${{ secrets.CODECOV_TOKEN }}
+        disable_search: true

.github/workflows/unit-tests.yml

@@ -1 +1,2 @@
-node_modules
+node_modules
+dist

.gitignore

@@ -0,0 +1,2 @@
+# Contributor Covenant
+[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](https://github.com/maplibre/maplibre/blob/main/CODE_OF_CONDUCT.md)

CODE_OF_CONDUCT.md

@@ -0,0 +1,7 @@
+# Contributing
+
+Thanks for getting involved and contributing to vt-pbf. Below are a few things to keep in mind when submitting a PR.
+
+* If adding new functionality, consider adding tests for it! Run the unit tests locally: `npm run test-unit`.
+* Make sure you run the linter and address any issues: `npm run lint`.
+* We're using rollup to bundle releases, run `npm run build` to create a new release inside `dist/`.

CONTRIBUTING.md

@@ -1,5 +1,7 @@
 The MIT License (MIT)
 
+Copyright (c) 2025 MapLibre contributors
+
 Copyright (c) 2015 Anand Thakker
 
 Permission is hereby granted, free of charge, to any person obtaining a copy

LICENSE

@@ -1,4 +1,6 @@
-# vt-pbf [![CircleCI](https://circleci.com/gh/mapbox/vt-pbf.svg?style=svg)](https://circleci.com/gh/mapbox/vt-pbf)
+[![MapLibre Logo](https://maplibre.org/img/maplibre-logo-big.svg)](https://maplibre.org/)
+
+# vt-pbf 
 
 Serialize [Mapbox vector tiles](https://github.com/mapbox/vector-tile-spec) to binary protobufs in javascript.
 
@@ -13,34 +15,34 @@ different:
 ## From vector-tile-js
 
 ```javascript
-var vtpbf = require('vt-pbf')
-var VectorTile = require('@mapbox/vector-tile').VectorTile
-var Protobuf = require('pbf')
+import {fromVectorTileJs} from 'vt-pbf'
+import {VectorTile} = from '@mapbox/vector-tile'
+import Protobuf from 'pbf'
 
 var data = fs.readFileSync(__dirname + '/fixtures/rectangle-1.0.0.pbf')
 var tile = new VectorTile(new Protobuf(data))
 var orig = tile.layers['geojsonLayer'].feature(0).toGeoJSON(0, 0, 1)
 
-var buff = vtpbf(tile)
+var buff = fromVectorTileJs(tile)
 fs.writeFileSync('my-tile.pbf', buff)
 ```
 
 ## From geojson-vt
 
 ```javascript
-var vtpbf = require('vt-pbf')
-var geojsonVt = require('geojson-vt')
+import {fromGeojsonVt} from 'vt-pbf'
+import geojsonVt from 'geojson-vt'
 
 var orig = JSON.parse(fs.readFileSync(__dirname + '/fixtures/rectangle.geojson'))
 var tileindex = geojsonVt(orig)
 var tile = tileindex.getTile(1, 0, 0)
 
 // pass in an object mapping layername -> tile object
-var buff = vtpbf.fromGeojsonVt({ 'geojsonLayer': tile })
+var buff = fromGeojsonVt({ 'geojsonLayer': tile })
 fs.writeFileSync('my-tile.pbf', buff)
 ```
 
-`vtpbf.fromGeojsonVt` takes two arguments:
+`fromGeojsonVt` takes two arguments:
 - `layerMap` is an object where keys are layer names and values are a geojson-vt tile,
 - `options` is an object (optional argument). There are 2 supported keys: `version` to define the version of the mvt spec used and `extent` to define the extent of the tile. `version` defaults to 1 and `extent` to 4096.
 

README.md

@@ -0,0 +1,2 @@
+For an up-to-date policy refer to
+https://github.com/maplibre/maplibre/blob/main/SECURITY.md