diff --git a/CLAUDE.md b/CLAUDE.md index 4dd2be7e8..1cb8e930a 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -84,7 +84,11 @@ As of version 3.0.0, the SDK has been updated to use modern JavaScript features ## TypeScript Support +- Full TypeScript support for mixed JS/TS codebases - Type definitions in index.d.ts +- TypeScript compilation via babel-preset-typescript +- See examples/typescript for a complete example +- For new development, both .js and .ts files are supported - Add JSDoc types to enable intellisense when needed ## Common Patterns diff --git a/Gruntfile.js b/Gruntfile.js index 5a12cffa6..02c85f6e9 100644 --- a/Gruntfile.js +++ b/Gruntfile.js @@ -11,6 +11,11 @@ var fs = require('fs'); var webpackConfig = require('./webpack.config.js'); +require('ts-node').register({ + transpileOnly: true, + compilerOptions: { module: 'commonjs' }, +}); + function findTests(context) { if (context !== 'browser') { return {}; diff --git a/babel.config.json b/babel.config.json index 2264f7c0a..14a0a211c 100644 --- a/babel.config.json +++ b/babel.config.json @@ -1,9 +1,7 @@ { "parserOpts": { "ecmaVersion": 2021, - "sourceType": "module", + "sourceType": "module" }, - "presets": [ - "@babel/preset-env" - ] + "presets": ["@babel/preset-env", "@babel/preset-typescript"] } diff --git a/examples/typescript/README.md b/examples/typescript/README.md new file mode 100644 index 000000000..746e37229 --- /dev/null +++ b/examples/typescript/README.md @@ -0,0 +1,36 @@ +# TypeScript Example + +This example shows how to use rollbar.js with TypeScript. The example demonstrates how to: + +- Import Rollbar in a TypeScript file +- Configure a Rollbar instance +- Use TypeScript interfaces with Rollbar +- Log messages and data with strong typing + +## Requirements + +- Node.js v18+ +- npm or yarn + +## Running the example + +```bash +# Install dependencies +npm install + +# Build the TypeScript files +npm run build + +# Run the example +npm start +``` + +## How it works + +The project includes: + +1. TypeScript configuration in `tsconfig.json` +2. Dependencies for TypeScript in `package.json` +3. Example TypeScript code in `src/example.ts` + +This example works because the rollbar.js library includes TypeScript definitions in `index.d.ts` and the build system has been configured to support TypeScript files. \ No newline at end of file diff --git a/examples/typescript/package.json b/examples/typescript/package.json new file mode 100644 index 000000000..0bf40a86a --- /dev/null +++ b/examples/typescript/package.json @@ -0,0 +1,21 @@ +{ + "name": "typescript-example", + "version": "1.0.0", + "description": "Example of using Rollbar with TypeScript", + "main": "dist/example.js", + "scripts": { + "tsc": "tsc", + "build": "tsc", + "start": "node ./dist/example.js", + "test": "echo \"Error: no test specified\" && exit 1" + }, + "author": "", + "license": "ISC", + "devDependencies": { + "typescript": "^5.0.0" + }, + "dependencies": { + "@types/node": "^18.0.0", + "rollbar": "file:../../" + } +} \ No newline at end of file diff --git a/examples/typescript/src/example.ts b/examples/typescript/src/example.ts new file mode 100644 index 000000000..db20dc445 --- /dev/null +++ b/examples/typescript/src/example.ts @@ -0,0 +1,30 @@ +import * as Rollbar from 'rollbar'; + +const rollbar = new Rollbar({ + accessToken: 'POST_SERVER_ITEM_ACCESS_TOKEN', + captureUncaught: true, + captureUnhandledRejections: true +}); + +// TypeScript example using strongly-typed parameters +interface User { + id: number; + name: string; + email: string; +} + +function processUser(user: User): void { + rollbar.info(`Processing user: ${user.name}`, user); +} + +// Create a user and process it +const user: User = { + id: 123, + name: 'Example User', + email: 'user@example.com' +}; + +processUser(user); + +// Log a message +rollbar.info('Hello from TypeScript!'); \ No newline at end of file diff --git a/examples/typescript/src/index.ts b/examples/typescript/src/index.ts new file mode 100644 index 000000000..359069972 --- /dev/null +++ b/examples/typescript/src/index.ts @@ -0,0 +1,12 @@ +export = function error() { + + class CustomError extends Error { + constructor(message: string) { + super(`Lorem "${message}" ipsum dolor.`); + this.name = 'CustomError'; + } + } + // TypeScript code snippet will include `` + var error = new CustomError('foo'); + throw error; +} diff --git a/examples/typescript/src/src/index.ts b/examples/typescript/src/src/index.ts new file mode 100644 index 000000000..359069972 --- /dev/null +++ b/examples/typescript/src/src/index.ts @@ -0,0 +1,12 @@ +export = function error() { + + class CustomError extends Error { + constructor(message: string) { + super(`Lorem "${message}" ipsum dolor.`); + this.name = 'CustomError'; + } + } + // TypeScript code snippet will include `` + var error = new CustomError('foo'); + throw error; +} diff --git a/examples/typescript/tsconfig.json b/examples/typescript/tsconfig.json new file mode 100644 index 000000000..c8a924fce --- /dev/null +++ b/examples/typescript/tsconfig.json @@ -0,0 +1,10 @@ +{ + "compilerOptions": { + "target": "es6", + "module": "commonjs", + "outDir": "dist", + "sourceMap": true + }, + "include": ["src/**/*.ts"], + "exclude": ["node_modules"] +} diff --git a/package-lock.json b/package-lock.json index 559d95bc0..5bcb93ed2 100644 --- a/package-lock.json +++ b/package-lock.json @@ -22,6 +22,7 @@ "@babel/core": "^7.26.10", "@babel/eslint-parser": "^7.27.0", "@babel/preset-env": "^7.26.9", + "@babel/preset-typescript": "^7.27.0", "babel-eslint": "^10.0.3", "babel-loader": "^9.2.1", "bluebird": "^3.3.5", @@ -72,6 +73,9 @@ "sinon": "^8.1.1", "stackframe": "^0.2.2", "time-grunt": "^1.0.0", + "ts-loader": "^9.5.2", + "ts-node": "^10.9.2", + "typescript": "^5.8.3", "vows": "^0.8.3", "webpack": "^5.98.0" } @@ -667,6 +671,38 @@ "@babel/core": "^7.0.0-0" } }, + "node_modules/@babel/plugin-syntax-jsx": { + "version": "7.25.9", + "resolved": "https://registry.npmjs.org/@babel/plugin-syntax-jsx/-/plugin-syntax-jsx-7.25.9.tgz", + "integrity": "sha512-ld6oezHQMZsZfp6pWtbjaNDF2tiiCYYDqQszHt5VV437lewP9aSi2Of99CK0D0XB21k7FLgnLcmQKyKzynfeAA==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.25.9" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, + "node_modules/@babel/plugin-syntax-typescript": { + "version": "7.25.9", + "resolved": "https://registry.npmjs.org/@babel/plugin-syntax-typescript/-/plugin-syntax-typescript-7.25.9.tgz", + "integrity": "sha512-hjMgRy5hb8uJJjUcdWunWVcoi9bGpJp8p5Ol1229PoN6aytsLwNMgmdftO23wnCLMfVmTwZDWMPNq/D1SY60JQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.25.9" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, "node_modules/@babel/plugin-syntax-unicode-sets-regex": { "version": "7.18.6", "resolved": "https://registry.npmjs.org/@babel/plugin-syntax-unicode-sets-regex/-/plugin-syntax-unicode-sets-regex-7.18.6.tgz", @@ -1454,6 +1490,26 @@ "@babel/core": "^7.0.0-0" } }, + "node_modules/@babel/plugin-transform-typescript": { + "version": "7.27.0", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-typescript/-/plugin-transform-typescript-7.27.0.tgz", + "integrity": "sha512-fRGGjO2UEGPjvEcyAZXRXAS8AfdaQoq7HnxAbJoAoW10B9xOKesmmndJv+Sym2a+9FHWZ9KbyyLCe9s0Sn5jtg==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/helper-annotate-as-pure": "^7.25.9", + "@babel/helper-create-class-features-plugin": "^7.27.0", + "@babel/helper-plugin-utils": "^7.26.5", + "@babel/helper-skip-transparent-expression-wrappers": "^7.25.9", + "@babel/plugin-syntax-typescript": "^7.25.9" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, "node_modules/@babel/plugin-transform-unicode-escapes": { "version": "7.25.9", "resolved": "https://registry.npmjs.org/@babel/plugin-transform-unicode-escapes/-/plugin-transform-unicode-escapes-7.25.9.tgz", @@ -1620,6 +1676,26 @@ "@babel/core": "^7.0.0-0 || ^8.0.0-0 <8.0.0" } }, + "node_modules/@babel/preset-typescript": { + "version": "7.27.0", + "resolved": "https://registry.npmjs.org/@babel/preset-typescript/-/preset-typescript-7.27.0.tgz", + "integrity": "sha512-vxaPFfJtHhgeOVXRKuHpHPAOgymmy8V8I65T1q53R7GCZlefKeCaTyDs3zOPHTTbmquvNlQYC5klEvWsBAtrBQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "@babel/helper-plugin-utils": "^7.26.5", + "@babel/helper-validator-option": "^7.25.9", + "@babel/plugin-syntax-jsx": "^7.25.9", + "@babel/plugin-transform-modules-commonjs": "^7.26.3", + "@babel/plugin-transform-typescript": "^7.27.0" + }, + "engines": { + "node": ">=6.9.0" + }, + "peerDependencies": { + "@babel/core": "^7.0.0-0" + } + }, "node_modules/@babel/runtime": { "version": "7.27.0", "resolved": "https://registry.npmjs.org/@babel/runtime/-/runtime-7.27.0.tgz", @@ -1710,6 +1786,30 @@ "node": ">=0.1.90" } }, + "node_modules/@cspotcode/source-map-support": { + "version": "0.8.1", + "resolved": "https://registry.npmjs.org/@cspotcode/source-map-support/-/source-map-support-0.8.1.tgz", + "integrity": "sha512-IchNf6dN4tHoMFIn/7OE8LWZ19Y6q/67Bmf6vnGREv8RSbBVb9LPJxEcnwrcwX6ixSvaiGoomAUvu4YSxXrVgw==", + "dev": true, + "license": "MIT", + "dependencies": { + "@jridgewell/trace-mapping": "0.3.9" + }, + "engines": { + "node": ">=12" + } + }, + "node_modules/@cspotcode/source-map-support/node_modules/@jridgewell/trace-mapping": { + "version": "0.3.9", + "resolved": "https://registry.npmjs.org/@jridgewell/trace-mapping/-/trace-mapping-0.3.9.tgz", + "integrity": "sha512-3Belt6tdc8bPgAtbcmdtNJlirVoTmEb5e2gC94PnkwEW9jI6CAHUeoG85tjWP5WquqfavoMtMwiG4P926ZKKuQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "@jridgewell/resolve-uri": "^3.0.3", + "@jridgewell/sourcemap-codec": "^1.4.10" + } + }, "node_modules/@eslint-community/eslint-utils": { "version": "4.5.1", "dev": true, @@ -2253,6 +2353,34 @@ "dev": true, "license": "MIT" }, + "node_modules/@tsconfig/node10": { + "version": "1.0.11", + "resolved": "https://registry.npmjs.org/@tsconfig/node10/-/node10-1.0.11.tgz", + "integrity": "sha512-DcRjDCujK/kCk/cUe8Xz8ZSpm8mS3mNNpta+jGCA6USEDfktlNvm1+IuZ9eTcDbNk41BHwpHHeW+N1lKCz4zOw==", + "dev": true, + "license": "MIT" + }, + "node_modules/@tsconfig/node12": { + "version": "1.0.11", + "resolved": "https://registry.npmjs.org/@tsconfig/node12/-/node12-1.0.11.tgz", + "integrity": "sha512-cqefuRsh12pWyGsIoBKJA9luFu3mRxCA+ORZvA4ktLSzIuCUtWVxGIuXigEwO5/ywWFMZ2QEGKWvkZG1zDMTag==", + "dev": true, + "license": "MIT" + }, + "node_modules/@tsconfig/node14": { + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/@tsconfig/node14/-/node14-1.0.3.tgz", + "integrity": "sha512-ysT8mhdixWK6Hw3i1V2AeRqZ5WfXg1G43mqoYlM2nc6388Fq5jcXyr5mRsqViLx/GJYdoL0bfXD8nmF+Zn/Iow==", + "dev": true, + "license": "MIT" + }, + "node_modules/@tsconfig/node16": { + "version": "1.0.4", + "resolved": "https://registry.npmjs.org/@tsconfig/node16/-/node16-1.0.4.tgz", + "integrity": "sha512-vxhUy4J8lyeyinH7Azl1pdd43GJhZH/tP2weN8TntQblOY+A0XbT8DJk1/oCPuOOyg/Ja757rG0CgHcWC8OfMA==", + "dev": true, + "license": "MIT" + }, "node_modules/@types/cookie": { "version": "0.4.1", "dev": true, @@ -2526,6 +2654,19 @@ "acorn": "^6.0.0 || ^7.0.0 || ^8.0.0" } }, + "node_modules/acorn-walk": { + "version": "8.3.4", + "resolved": "https://registry.npmjs.org/acorn-walk/-/acorn-walk-8.3.4.tgz", + "integrity": "sha512-ueEepnujpqee2o5aIYnvHU6C0A42MNdsIDeqy5BydrkuC5R1ZuUFnm27EeFJGoEHJQgn3uleRvmTXaJgfXbt4g==", + "dev": true, + "license": "MIT", + "dependencies": { + "acorn": "^8.11.0" + }, + "engines": { + "node": ">=0.4.0" + } + }, "node_modules/ajv": { "version": "6.12.6", "dev": true, @@ -2623,6 +2764,13 @@ "node": ">= 8" } }, + "node_modules/arg": { + "version": "4.1.3", + "resolved": "https://registry.npmjs.org/arg/-/arg-4.1.3.tgz", + "integrity": "sha512-58S9QDqG0Xx27YwPSt9fJxivjYl432YCwfDMfZ+71RAqUrZef7LrKQZ3LHLOwCS4FLNBplP533Zx895SeOCHvA==", + "dev": true, + "license": "MIT" + }, "node_modules/argparse": { "version": "1.0.10", "dev": true, @@ -3443,6 +3591,13 @@ "node": ">=10" } }, + "node_modules/create-require": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/create-require/-/create-require-1.1.1.tgz", + "integrity": "sha512-dcKFX3jn0MpIaXjisoRvexIJVEKzaq7z2rZKxf+MSr9TkdmHmsU4m2lcLojrj/FHl8mk5VxMmYA+ftRkP/3oKQ==", + "dev": true, + "license": "MIT" + }, "node_modules/cross-spawn": { "version": "7.0.6", "dev": true, @@ -6929,6 +7084,13 @@ "version": "2.2.4", "license": "MIT" }, + "node_modules/make-error": { + "version": "1.3.6", + "resolved": "https://registry.npmjs.org/make-error/-/make-error-1.3.6.tgz", + "integrity": "sha512-s8UhlNe7vPKomQhC1qFelMokr/Sc3AgNbso3n74mVPA5LTZwkB9NlXf4XPamLxJE8h0gh73rM94xvwRT2CVInw==", + "dev": true, + "license": "ISC" + }, "node_modules/make-iterator": { "version": "1.0.1", "dev": true, @@ -9540,6 +9702,180 @@ "node": ">=0.6" } }, + "node_modules/ts-loader": { + "version": "9.5.2", + "resolved": "https://registry.npmjs.org/ts-loader/-/ts-loader-9.5.2.tgz", + "integrity": "sha512-Qo4piXvOTWcMGIgRiuFa6nHNm+54HbYaZCKqc9eeZCLRy3XqafQgwX2F7mofrbJG3g7EEb+lkiR+z2Lic2s3Zw==", + "dev": true, + "license": "MIT", + "dependencies": { + "chalk": "^4.1.0", + "enhanced-resolve": "^5.0.0", + "micromatch": "^4.0.0", + "semver": "^7.3.4", + "source-map": "^0.7.4" + }, + "engines": { + "node": ">=12.0.0" + }, + "peerDependencies": { + "typescript": "*", + "webpack": "^5.0.0" + } + }, + "node_modules/ts-loader/node_modules/ansi-styles": { + "version": "4.3.0", + "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-4.3.0.tgz", + "integrity": "sha512-zbB9rCJAT1rbjiVDb2hqKFHNYLxgtk8NURxZ3IZwD3F6NtxbXZQCnnSi1Lkx+IDohdPlFp222wVALIheZJQSEg==", + "dev": true, + "license": "MIT", + "dependencies": { + "color-convert": "^2.0.1" + }, + "engines": { + "node": ">=8" + }, + "funding": { + "url": "https://github.com/chalk/ansi-styles?sponsor=1" + } + }, + "node_modules/ts-loader/node_modules/chalk": { + "version": "4.1.2", + "resolved": "https://registry.npmjs.org/chalk/-/chalk-4.1.2.tgz", + "integrity": "sha512-oKnbhFyRIXpUuez8iBMmyEa4nbj4IOQyuhc/wy9kY7/WVPcwIO9VA668Pu8RkO7+0G76SLROeyw9CpQ061i4mA==", + "dev": true, + "license": "MIT", + "dependencies": { + "ansi-styles": "^4.1.0", + "supports-color": "^7.1.0" + }, + "engines": { + "node": ">=10" + }, + "funding": { + "url": "https://github.com/chalk/chalk?sponsor=1" + } + }, + "node_modules/ts-loader/node_modules/color-convert": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/color-convert/-/color-convert-2.0.1.tgz", + "integrity": "sha512-RRECPsj7iu/xb5oKYcsFHSppFNnsj/52OVTRKb4zP5onXwVF3zVmmToNcOfGC+CRDpfK/U584fMg38ZHCaElKQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "color-name": "~1.1.4" + }, + "engines": { + "node": ">=7.0.0" + } + }, + "node_modules/ts-loader/node_modules/color-name": { + "version": "1.1.4", + "resolved": "https://registry.npmjs.org/color-name/-/color-name-1.1.4.tgz", + "integrity": "sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA==", + "dev": true, + "license": "MIT" + }, + "node_modules/ts-loader/node_modules/has-flag": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/has-flag/-/has-flag-4.0.0.tgz", + "integrity": "sha512-EykJT/Q1KjTWctppgIAgfSO0tKVuZUjhgMr17kqTumMl6Afv3EISleU7qZUzoXDFTAHTDC4NOoG/ZxU3EvlMPQ==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=8" + } + }, + "node_modules/ts-loader/node_modules/semver": { + "version": "7.7.1", + "resolved": "https://registry.npmjs.org/semver/-/semver-7.7.1.tgz", + "integrity": "sha512-hlq8tAfn0m/61p4BVRcPzIGr6LKiMwo4VM6dGi6pt4qcRkmNzTcWq6eCEjEh+qXjkMDvPlOFFSGwQjoEa6gyMA==", + "dev": true, + "license": "ISC", + "bin": { + "semver": "bin/semver.js" + }, + "engines": { + "node": ">=10" + } + }, + "node_modules/ts-loader/node_modules/source-map": { + "version": "0.7.4", + "resolved": "https://registry.npmjs.org/source-map/-/source-map-0.7.4.tgz", + "integrity": "sha512-l3BikUxvPOcn5E74dZiq5BGsTb5yEwhaTSzccU6t4sDOH8NWJCstKO5QT2CvtFoK6F0saL7p9xHAqHOlCPJygA==", + "dev": true, + "license": "BSD-3-Clause", + "engines": { + "node": ">= 8" + } + }, + "node_modules/ts-loader/node_modules/supports-color": { + "version": "7.2.0", + "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-7.2.0.tgz", + "integrity": "sha512-qpCAvRl9stuOHveKsn7HncJRvv501qIacKzQlO/+Lwxc9+0q2wLyv4Dfvt80/DPn2pqOBsJdDiogXGR9+OvwRw==", + "dev": true, + "license": "MIT", + "dependencies": { + "has-flag": "^4.0.0" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/ts-node": { + "version": "10.9.2", + "resolved": "https://registry.npmjs.org/ts-node/-/ts-node-10.9.2.tgz", + "integrity": "sha512-f0FFpIdcHgn8zcPSbf1dRevwt047YMnaiJM3u2w2RewrB+fob/zePZcrOyQoLMMO7aBIddLcQIEK5dYjkLnGrQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "@cspotcode/source-map-support": "^0.8.0", + "@tsconfig/node10": "^1.0.7", + "@tsconfig/node12": "^1.0.7", + "@tsconfig/node14": "^1.0.0", + "@tsconfig/node16": "^1.0.2", + "acorn": "^8.4.1", + "acorn-walk": "^8.1.1", + "arg": "^4.1.0", + "create-require": "^1.1.0", + "diff": "^4.0.1", + "make-error": "^1.1.1", + "v8-compile-cache-lib": "^3.0.1", + "yn": "3.1.1" + }, + "bin": { + "ts-node": "dist/bin.js", + "ts-node-cwd": "dist/bin-cwd.js", + "ts-node-esm": "dist/bin-esm.js", + "ts-node-script": "dist/bin-script.js", + "ts-node-transpile-only": "dist/bin-transpile.js", + "ts-script": "dist/bin-script-deprecated.js" + }, + "peerDependencies": { + "@swc/core": ">=1.2.50", + "@swc/wasm": ">=1.2.50", + "@types/node": "*", + "typescript": ">=2.7" + }, + "peerDependenciesMeta": { + "@swc/core": { + "optional": true + }, + "@swc/wasm": { + "optional": true + } + } + }, + "node_modules/ts-node/node_modules/diff": { + "version": "4.0.2", + "resolved": "https://registry.npmjs.org/diff/-/diff-4.0.2.tgz", + "integrity": "sha512-58lmxKSA4BNyLz+HHMUzlOEpg09FV+ev6ZMe3vJihgdxzgcwZ8VoEEPmALCZG9LmqfVoNMMKpttIYTVG6uDY7A==", + "dev": true, + "license": "BSD-3-Clause", + "engines": { + "node": ">=0.3.1" + } + }, "node_modules/tty-browserify": { "version": "0.0.0", "dev": true, @@ -9576,6 +9912,20 @@ "node": ">= 0.6" } }, + "node_modules/typescript": { + "version": "5.8.3", + "resolved": "https://registry.npmjs.org/typescript/-/typescript-5.8.3.tgz", + "integrity": "sha512-p1diW6TqL9L07nNxvRMM7hMMw4c5XOo/1ibL4aAIGmSAt9slTE1Xgw5KWuof2uTOvCg9BY7ZRi+GaF+7sfgPeQ==", + "dev": true, + "license": "Apache-2.0", + "bin": { + "tsc": "bin/tsc", + "tsserver": "bin/tsserver" + }, + "engines": { + "node": ">=14.17" + } + }, "node_modules/ua-parser-js": { "version": "0.7.35", "dev": true, @@ -9782,6 +10132,13 @@ "node": ">= 0.4.0" } }, + "node_modules/v8-compile-cache-lib": { + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/v8-compile-cache-lib/-/v8-compile-cache-lib-3.0.1.tgz", + "integrity": "sha512-wa7YjyUGfNZngI/vtK0UHAN+lgDCxBPCylVXGp0zu59Fz5aiGtNXaq3DhIov063MorB+VfufLh3JlF2KdTK3xg==", + "dev": true, + "license": "MIT" + }, "node_modules/v8flags": { "version": "4.0.1", "resolved": "https://registry.npmjs.org/v8flags/-/v8flags-4.0.1.tgz", @@ -10300,6 +10657,16 @@ "url": "https://github.com/sponsors/sindresorhus" } }, + "node_modules/yn": { + "version": "3.1.1", + "resolved": "https://registry.npmjs.org/yn/-/yn-3.1.1.tgz", + "integrity": "sha512-Ux4ygGWsu2c7isFWe8Yu1YluJmqVhxqK2cLXNQA5AcC3QfbGNpM7fu0Y8b/z16pXLnFxZYvWhd3fhBY9DLmC6Q==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">=6" + } + }, "node_modules/yocto-queue": { "version": "0.1.0", "dev": true, diff --git a/package.json b/package.json index 567944072..8daa7f5ef 100644 --- a/package.json +++ b/package.json @@ -31,6 +31,7 @@ "@babel/core": "^7.26.10", "@babel/eslint-parser": "^7.27.0", "@babel/preset-env": "^7.26.9", + "@babel/preset-typescript": "^7.27.0", "babel-eslint": "^10.0.3", "babel-loader": "^9.2.1", "bluebird": "^3.3.5", @@ -81,6 +82,9 @@ "sinon": "^8.1.1", "stackframe": "^0.2.2", "time-grunt": "^1.0.0", + "ts-loader": "^9.5.2", + "ts-node": "^10.9.2", + "typescript": "^5.8.3", "vows": "^0.8.3", "webpack": "^5.98.0" }, diff --git a/src/browser/telemetry.js b/src/browser/telemetry.js index ea115b58e..88b34f131 100644 --- a/src/browser/telemetry.js +++ b/src/browser/telemetry.js @@ -1,6 +1,6 @@ var _ = require('../utility'); var headers = require('../utility/headers'); -var replace = require('../utility/replace'); +var replace = require('../utility/replace.ts'); var scrub = require('../scrub'); var urlparser = require('./url'); var domUtil = require('./domUtility'); diff --git a/src/server/telemetry.js b/src/server/telemetry.js index 0e614c344..8371154df 100644 --- a/src/server/telemetry.js +++ b/src/server/telemetry.js @@ -1,7 +1,7 @@ var http = require('http'); var https = require('https'); var _ = require('../utility'); -var replace = require('../utility/replace'); +var replace = require('../utility/replace.ts'); var urlHelpers = require('./telemetry/urlHelpers'); var defaults = { diff --git a/src/utility/replace.js b/src/utility/replace.js deleted file mode 100644 index de120ad8e..000000000 --- a/src/utility/replace.js +++ /dev/null @@ -1,9 +0,0 @@ -function replace(obj, name, replacement, replacements, type) { - var orig = obj[name]; - obj[name] = replacement(orig); - if (replacements) { - replacements[type].push([obj, name, orig]); - } -} - -module.exports = replace; diff --git a/src/utility/replace.ts b/src/utility/replace.ts new file mode 100644 index 000000000..cb8de9c9c --- /dev/null +++ b/src/utility/replace.ts @@ -0,0 +1,22 @@ +/** + * Replace a property of an object with a new function + * + * @param obj The object containing the property to replace + * @param name The name of the property to replace + * @param replacement A function that takes the original value and returns the replacement + * @param replacements Optional object to store replacement history + * @param type Optional string indicating the type of replacement + */ +export default function replace( + obj: Record, + name: string, + replacement: (orig: any) => any, + replacements?: { [key: string]: Array<[Record, string, any]> }, + type?: string, +): void { + const orig = obj[name]; + obj[name] = replacement(orig); + if (replacements && type) { + replacements[type].push([obj, name, orig]); + } +} diff --git a/tsconfig.json b/tsconfig.json new file mode 100644 index 000000000..5d02735cc --- /dev/null +++ b/tsconfig.json @@ -0,0 +1,22 @@ +{ + "compilerOptions": { + "target": "es5", + "module": "esnext", + "moduleResolution": "node", + "strict": false, + "importHelpers": true, + "skipLibCheck": true, + "esModuleInterop": true, + "allowSyntheticDefaultImports": true, + "sourceMap": true, + "baseUrl": ".", + "outDir": "./dist", + "declaration": true, + "paths": { + "*": ["node_modules/*"] + }, + "lib": ["esnext", "dom", "dom.iterable"] + }, + "include": ["src/**/*.ts", "src/**/*.js"], + "exclude": ["node_modules", "dist"] +} \ No newline at end of file diff --git a/webpack.config.js b/webpack.config.js index cb1489539..98e726090 100644 --- a/webpack.config.js +++ b/webpack.config.js @@ -21,10 +21,13 @@ var snippetConfig = { filename: '[name].js', }, plugins: [defaultsPlugin], + resolve: { + extensions: ['.ts', '.js', '.json'], + }, module: { rules: [ { - test: /\.js$/, + test: /\.(js|ts)$/, loader: 'babel-loader', exclude: [/node_modules/, /vendor/], }, @@ -42,10 +45,13 @@ var pluginConfig = { filename: '[name].min.js', }, plugins: [defaultsPlugin], + resolve: { + extensions: ['.ts', '.js', '.json'], + }, module: { rules: [ { - test: /\.js$/, + test: /\.(js|ts)$/, loader: 'babel-loader', exclude: [/node_modules/, /vendor/], }, @@ -63,10 +69,13 @@ var vanillaConfigBase = { target: ['web', 'es5'], plugins: [defaultsPlugin], devtool: 'hidden-source-map', + resolve: { + extensions: ['.ts', '.js', '.json'], + }, module: { rules: [ { - test: /\.js$/, + test: /\.(js|ts)$/, loader: 'babel-loader', exclude: [/node_modules/, /vendor/], }, @@ -86,10 +95,13 @@ var UMDConfigBase = { }, target: ['web', 'es5'], devtool: 'source-map', + resolve: { + extensions: ['.ts', '.js', '.json'], + }, module: { rules: [ { - test: /\.js$/, + test: /\.(js|ts)$/, loader: 'babel-loader', exclude: [/node_modules/, /vendor/], },