Merge pull request #39 from versatica/use-multiple-exports-and-expose-esm-and-cjs-files

Author: ibc

.editorconfig

@@ -9,7 +9,7 @@ charset = utf-8
 trim_trailing_whitespace = true
 insert_final_newline = true
 
-[*.{ts,js,mjs}]
+[*.{ts,mts,mjs,cjs,js}]
 indent_style = tab
 
 [*.json]

README.md

@@ -18,7 +18,7 @@ npm install rtp.js
 - All RTP and RTCP classes, types and packet related helpers are exported by the `packets` module.
 
   ```ts
-  import { packets } from 'rtp.js';
+  import * as packets from 'rtp.js/packets';
 
   const {
   	isRtp,
@@ -46,17 +46,32 @@ npm install rtp.js
 - The `utils` module exports some generic helpers and utilities.
 
   ```ts
-  import { utils } from 'rtp.js';
+  import * as utils from 'rtp.js/packets';
 
-  const view = utils.stringToDataView('foo');
+  const view = utils.stringToDataView('fooœæ€ñ#¢∞Ω©bar');
   ```
 
 - CommonJS is also supported:
 
   ```ts
-  const { packets, utils } = require('rtp.js');
+  const packets = require('rtp.js/packets');
+  const utils = require('rtp.js/utils');
   ```
 
+- Single entry point ("main" or "module" entries in `package.json`) is also possible for backwards compatibility:
+
+  ```ts
+  // ESM
+  import { packets, utils } from 'rtp.js';
+
+  // CJS
+  const { packets, utils } = require('rtp.js'=;
+  ```
+
+## Note about TypeScript
+
+**rtp.js** is written in TypeScript with `module: NodeNext`, meaning that TypeScript projects that have **rtp.js** as dependency must have `moduleResolution` with value "node16", 'NodeNext" or "bundler" in their `tsconfig.json` file.
+
 ## Authors
 
 - Iñaki Baz Castillo [[website](https://inakibaz.me)|[github](https://github.com/ibc/)]

babel.config-cjs.mjs

@@ -0,0 +1,34 @@
+/**
+ * This is Babel configuration for transpilation of TypeScript files into
+ * JavaScript CJS files (.cjs).
+ */
+
+export default {
+	presets: [
+		[
+			'@babel/preset-env',
+			{
+				// Convert ESM modules to CJS.
+				modules: 'commonjs',
+				targets: 'defaults',
+			},
+		],
+		['@babel/preset-typescript', { allowDeclareFields: true }],
+	],
+	plugins: [
+		// We need to replace the .mts extension of imports/exports with .cjs,
+		// otherwise Babel will remove the extension of the import and the parent
+		// application will fail to resolve its location.
+		[
+			'module-resolver',
+			{
+				extensions: ['.cjs'],
+				resolvePath(sourcePath /* , currentFile, opts */) {
+					return sourcePath.endsWith('.mts')
+						? sourcePath.replace(/\.mts$/, '.cjs')
+						: sourcePath;
+				},
+			},
+		],
+	],
+};

babel.config-esm.mjs

@@ -0,0 +1,34 @@
+/**
+ * This is Babel configuration for transpilation of TypeScript files into
+ * JavaScript ESM files (.mjs).
+ */
+
+export default {
+	presets: [
+		[
+			'@babel/preset-env',
+			{
+				// Do not convert ESM modules to anything else (keep ESM).
+				modules: false,
+				targets: 'defaults',
+			},
+		],
+		['@babel/preset-typescript', { allowDeclareFields: true }],
+	],
+	plugins: [
+		// We need to replace the .mts extension of imports/exports with .mjs,
+		// otherwise Babel will remove the extension of the import and the parent
+		// application will fail to resolve its location.
+		[
+			'module-resolver',
+			{
+				extensions: ['.mjs'],
+				resolvePath(sourcePath /* , currentFile, opts */) {
+					return sourcePath.endsWith('.mts')
+						? sourcePath.replace(/\.mts$/, '.mjs')
+						: sourcePath;
+				},
+			},
+		],
+	],
+};

babel.config-jest.cjs

@@ -0,0 +1,24 @@
+/**
+ * This is Babel configuration for transpilation of TypeScript files into
+ * JavaScript CJS files when running Jest with ts-jest.
+ *
+ * In this case we don't want to replace the .mts extension of imports/exports
+ * (otherwise Jest will fail to locate them).
+ *
+ * NOTE: This file is CJS rather than ESM because older version of Node.js
+ * cannot load Babel ESM configuration files synchronously.
+ */
+
+module.exports = {
+	presets: [
+		[
+			'@babel/preset-env',
+			{
+				// Convert ESM modules to CJS.
+				modules: 'commonjs',
+				targets: 'defaults',
+			},
+		],
+		['@babel/preset-typescript', { allowDeclareFields: true }],
+	],
+};

babel.config.cjs

@@ -8,7 +8,7 @@ const config = tsEslint.config(
 	{
 		languageOptions: {
 			sourceType: 'module',
-			globals: { ...globals.browser },
+			globals: { ...globals.node },
 		},
 		linterOptions: {
 			noInlineConfig: false,
@@ -107,19 +107,21 @@ const config = tsEslint.config(
 			yoda: 2,
 		},
 	},
-	// NOTE: We need to apply this only to .ts files (and not to .mjs files).
+	// NOTE: We need to apply this only to .mts source files (and not to .mjs
+	// files).
 	...tsEslint.configs.recommendedTypeChecked.map(item => ({
 		...item,
-		files: ['src/**/*.ts'],
+		files: ['src/**/*.mts'],
 	})),
-	// NOTE: We need to apply this only to .ts files (and not to .mjs files).
+	// NOTE: We need to apply this only to .mts source files (and not to .mjs
+	// files).
 	...tsEslint.configs.stylisticTypeChecked.map(item => ({
 		...item,
-		files: ['src/**/*.ts'],
+		files: ['src/**/*.mts'],
 	})),
 	{
-		name: '.ts files',
-		files: ['src/**/*.ts'],
+		name: '.mts source files',
+		files: ['src/**/*.mts'],
 		languageOptions: {
 			parserOptions: {
 				projectService: true,
@@ -163,9 +165,9 @@ const config = tsEslint.config(
 		},
 	},
 	{
-		name: '.ts test files',
+		name: '.mts test files',
 		...jestEslint.configs['flat/recommended'],
-		files: ['src/test/**/*.ts'],
+		files: ['src/test/**/*.mts'],
 		rules: {
 			...jestEslint.configs['flat/recommended'].rules,
 			'jest/no-disabled-tests': 2,

eslint.config.mjs

@@ -0,0 +1,22 @@
+const config = {
+	verbose: true,
+	testEnvironment: 'node',
+	testRegex: 'src/test/.*.test.mts',
+	// Make Jest consider .mts files as if they were ES modules.
+	moduleFileExtensions: ['mts', 'mjs', 'js', 'ts'],
+	transform: {
+		'^.+\\.mts?$': [
+			'babel-jest',
+			{
+				// We need special Babel settings for Jest plust we need it to be in
+				// a CJS configuration file, otherwise old versions of Node will fail
+				// to run Jest.
+				configFile: './babel.config-jest.cjs',
+			},
+		],
+	},
+	coveragePathIgnorePatterns: ['src/Logger.mts', 'src/test'],
+	cacheDirectory: '.cache/jest',
+};
+
+export default config;