fix: include type definitions when publishing

.gitignore

@@ -26,3 +26,6 @@ Thumbs.db
 
 # SMP artifacts from testing
 /*.smp
+
+# Published directory for type definitions
+dist/

lib/index.js

@@ -1,3 +1,6 @@
+/** @typedef {import('./types.js').SMPSource} SMPSource */
+/** @typedef {import('./types.js').SMPStyle} SMPStyle */
+
 export { default as Reader } from './reader.js'
 export { default as Writer } from './writer.js'
 export { default as Server } from './server.js'

lib/utils/streams.js

@@ -123,18 +123,20 @@ export function isWebReadableStream(obj) {
 }
 
 /** @typedef {(opts: { totalBytes: number, chunkBytes: number }) => void} ProgressCallback */
+/** @typedef {TransformOptions & { onprogress?: ProgressCallback }} ProgressStreamOptions */
 
 /**
  * Passthrough stream that counts the bytes passing through it. Pass an optional
  * `onprogress` callback that will be called with the accumulated total byte
  * count and the chunk byte count after each chunk.
+ * @extends {Transform}
  */
 export class ProgressStream extends Transform {
   #onprogress
   #byteLength = 0
 
   /**
-   * @param {TransformOptions & { onprogress?: ProgressCallback }} [opts]
+   * @param {ProgressStreamOptions} [opts]
    */
   constructor({ onprogress, ...opts } = {}) {
     super(opts)
@@ -147,6 +149,7 @@ export class ProgressStream extends Transform {
   }
 
   /**
+   * @override
    * @param {Buffer | Uint8Array} chunk
    * @param {Parameters<Transform['_transform']>[1]} encoding
    * @param {Parameters<Transform['_transform']>[2]} callback

package.json

@@ -3,23 +3,55 @@
   "version": "1.0.1",
   "description": "",
   "exports": {
-    ".": "./lib/index.js",
-    "./reader": "./lib/reader.js",
-    "./writer": "./lib/writer.js",
-    "./server": "./lib/server.js",
-    "./style-downloader": "./lib/style-downloader.js",
-    "./tile-downloader": "./lib/tile-downloader.js",
-    "./download": "./lib/download.js"
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./lib/index.js"
+    },
+    "./reader": {
+      "types": "./dist/reader.d.ts",
+      "import": "./lib/reader.js"
+    },
+    "./writer": {
+      "types": "./dist/writer.d.ts",
+      "import": "./lib/writer.js"
+    },
+    "./server": {
+      "types": "./dist/server.d.ts",
+      "import": "./lib/server.js"
+    },
+    "./style-downloader": {
+      "types": "./dist/style-downloader.d.ts",
+      "import": "./lib/style-downloader.js"
+    },
+    "./tile-downloader": {
+      "types": "./dist/tile-downloader.d.ts",
+      "import": "./lib/tile-downloader.js"
+    },
+    "./download": {
+      "types": "./dist/download.d.ts",
+      "import": "./lib/download.js"
+    }
   },
+  "main": "./lib/index.js",
+  "types": "./dist/index.d.ts",
   "bin": {
     "styled-map-package": "./bin/smp.js",
     "smp": "./bin/smp.js"
   },
   "type": "module",
+  "files": [
+    "bin",
+    "dist",
+    "lib",
+    "map-viewer"
+  ],
   "scripts": {
-    "test": "npm run lint && node --test",
+    "test": "npm run lint && npm run types && node --test",
     "prepare": "husky",
-    "lint": "eslint ."
+    "lint": "eslint .",
+    "types": "tsc",
+    "build:types": "rimraf \"dist/\" && tsc -p tsconfig.publish.json",
+    "prepack": "npm run build:types"
   },
   "keywords": [],
   "author": "",
@@ -80,6 +112,7 @@
     "png-stream": "^1.0.5",
     "prettier": "^3.3.3",
     "random-bytes-readable-stream": "^3.0.0",
+    "rimraf": "^4.4.1",
     "type-fest": "^4.26.0",
     "typescript": "5.5.4"
   },

test/utils/digest-stream.js

@@ -12,6 +12,7 @@ export class DigestStream extends Transform {
     this.#hash = createHash(algorithm)
   }
   /**
+   * @override
    * @param {*} chunk
    * @param {BufferEncoding} encoding
    * @param {import('node:stream').TransformCallback} callback