Migrate build system to esbuild #261

tharropoulos · 2025-02-05T14:15:42Z

Change Summary

What is this?

This change modernizes the build system by migrating from webpack to tsup (powered by esbuild) for improved bundle generation. It enhances package exports configuration to better support both CommonJS and ESM environments while ensuring proper browser polyfills and type definitions.

Changes

Build System Updates:

Migrated to tsup:
- Replaced webpack with tsup for faster and more efficient builds
- Added tsup.config.ts with configurations for browser and Node.js targets
- Configured dual ESM/CJS output with .mjs/.js extensions
- Set up source maps and minification

Package Configuration:

Updated Package Exports:
- Added exports field with conditional exports for CJS/ESM
- Updated main, module, and types fields
- Configured browser polyfills for crypto, http, and https

Dependencies:

Removed Dependencies:
- Removed @babel/runtime peer dependency
Added Dependencies:
- Added browserslist and browserslist-to-esbuild for browser targeting
- Added esbuild-plugins-node-modules-polyfill for Node.js built-ins
- Added tsup for build system

Type System Improvements:

In src/Typesense.ts:
- Added explicit type exports for all modules
- Improved module export structure
- Added comprehensive type definitions

Code Improvements:

In src/Typesense/Configuration.ts:
- Fixed logger import to avoid UMD module issues
- Improved type handling for logger configuration

Context

This modernization effort improves the package's compatibility with modern JavaScript tooling while maintaining support for older environments. The migration to tsup provides faster builds and better tree-shaking capabilities, resulting in smaller bundle sizes.

PR Checklist

I have read and signed the Contributor License Agreement.

Modernize build system and package configuration - Migrate from webpack to tsup for improved build process. - Update package.json with new exports configuration and dependencies. - Add tsup.config.ts for flexible bundling options. - Target both cjs and esm. - Use minified versions of bundle by default.

- `loglevel` is written as a UMD module and has to be handled differently from axios

- add type exports for all modules via `export type *` - fix browser polyfills by using `empty` modules for node builtins - fix output directories by swapping `lib` and `dist` outputs - update mainFields to prioritize browser field

jasonbosco

Could you remove the typesense data dir from this commit:

Looks like the individual JS files, source maps and type files inside the lib directory are missing now. Could we add those back, so we don't break apps where users might be directly importing these individual files?
Could we also add the unminimized Typesense.js file back into lib?
Could we keep the file names consistent with before (all lower case) inside the dist directory and also add back the unminified version as well?

- add `Stemming`, `StemmingDictionaries`, and `StemmingDictionary` classes - implement dictionary CRUD operations with `upsert` and `retrieve` methods - add stemming property to main client class - add tests for stemming functionality

…arch

…level

- refactor `StemmingDictionaryCreateSchema` to use single word-root pairs - update `upsert` method to handle JSONL format for dictionaries - fix typo in `StemmingDictionary` class name - change endpoint path from `/stemming/dictionary` to `/dictionaries` - add JSONL conversion for array inputs and string handling

- run `tsc` before `tsup` in `build` script - remove duplicate browser configuration from `tsup.config.ts` - simplify build process while maintaining browser compatibility

- update `.` export to use correct `import` and `require` fields - add `default` field for compatibiliy with typescript imports - rename `browser.ts` entry point to support module resolution - update build configuration to use new entry point

- split `tsconfig.json` into base, cjs and esm variants - update `build` script to use dedicated cjs config - simplify main tsconfig by extending from base config - configure tsup to use esm config for browser builds

- merge `browser.ts` exports into main `Typesense.ts` file - update tsup config to use single entry point - simplify export pattern for core modules - streamline type exports

- add explicit `treeshake` flag in tsup config - set browser-specific mainFields for module resolution - consolidate build optimization settings

- add `src` directory to published files in `package.json` - remove redundant browser file cleanup step - expand package export configuration in `package.json` to include unminified versions of the browser bundle

- add documentation for `SearchClient` browser usage - clarify commonjs and esm bundle formats - update build tool information from browserify to tsup

- avoid module resolution failures from parcel not respecting the `exports` field

- add test for empty array input - add test for empty string input - add test for null input - add test for undefined input

tharropoulos · 2025-02-07T13:38:12Z

Looks like the individual JS files, source maps and type files inside the lib directory are missing now. Could we add those back, so we don't break apps where users might be directly importing these individual files?

Done in bfdfee0, opted to use tsc for node-specific builds targeting CommonJS

Could we also add the unminimized Typesense.js file back into lib?

The unminified bundle is now in ae7de6c. Users can access it by using the absolute node_modules path when importing. By default, it will use the minified version.

Could we keep the file names consistent with before (all lower case) inside the dist directory and also add back the unminified version as well?

Changed the entrypoint name altogether in e5aaf4b, to address problems with module resolutions in bundlers like parcel. By default, parcel resolves paths in absolutely, so importing by "typesense/dist" doesn't work currently, as there isn't a "typesense/dist.js" file inside the "dist" bundle. It would only work with "typesense/dist/typesense".

tharropoulos · 2025-05-09T10:18:58Z

@jasonbosco I think we need to merge this in order to tackle #288.

…ied-bundles

tharropoulos added 12 commits February 5, 2025 16:03

chore

cb65a2e

build: add cjs plugin or esbuild

bdb1463

fix: import from cjs on require

ba3c290

build: add esbuild options for bundling UMD dependencies

93942ee

- `loglevel` is written as a UMD module and has to be handled differently from axios

fix: avoid reusing logger import from loglevel

838c9bd

chore: remove uneeded common-js dependency for esbuild

2b51b85

chore: add prepare script to run before package publishing

8a6596d

chore: update package-lock based on changes

b337526

feat(build): export types and fix browser polyfills

3b69e10

- add type exports for all modules via `export type *` - fix browser polyfills by using `empty` modules for node builtins - fix output directories by swapping `lib` and `dist` outputs - update mainFields to prioritize browser field

chore(build): remove peer dependency for babel runtime

72f1b98

chore: build artifacts

0c8c173

This was referenced Feb 5, 2025

[Feature] Create small .js file conaining ONLY search-related functionality (for use in browser) #222

Open

Expose types again #153

Open

tharropoulos marked this pull request as ready for review February 5, 2025 14:51

jasonbosco requested changes Feb 5, 2025

View reviewed changes

chore: remove typesense-data from source control

8dea7d5

tharropoulos force-pushed the minified-bundle branch from 7c502dd to 8dea7d5 Compare February 6, 2025 09:25

tharropoulos added 12 commits February 6, 2025 16:58

feat(multi-search): add union parameter to multisearch

f7b687e

feat(client): add stemming dictionaries support

5663223

- add `Stemming`, `StemmingDictionaries`, and `StemmingDictionary` classes - implement dictionary CRUD operations with `upsert` and `retrieve` methods - add stemming property to main client class - add tests for stemming functionality

feat(multi-search): add rerank_hybrid_searches parameter to multise…

5353759

…arch

feat(field): add tokens_separators and symbols_to_index to field-…

d2c0eba

…level

feat(collections): add collection truncation option

d389717

feat(fields): add geopolygon field type

efa6bed

feat(search): add max_filter_by_candidates search param

b7350c9

feat(operations): add the schema_changes operation option

d58512c

fix: remove redudant stemming dict file

c2dacf1

fix(stemming): fix stemming resource path

ec09e2d

fix(stemming): fix tests for stemming

bdebd1f

tharropoulos and others added 18 commits February 6, 2025 16:58

fix(types): fix return type for stemming dictionaries

d5ca72b

build: configure tsc and tsup for dual compilation

bfdfee0

- run `tsc` before `tsup` in `build` script - remove duplicate browser configuration from `tsup.config.ts` - simplify build process while maintaining browser compatibility

build: add unminified version of browser dist

ae7de6c

chore: build artifacts

5cddab3

build: refactor typescript configuration for dual module builds

a78adb9

- split `tsconfig.json` into base, cjs and esm variants - update `build` script to use dedicated cjs config - simplify main tsconfig by extending from base config - configure tsup to use esm config for browser builds

refactor: consolidate browser and main typesense exports

ff485f9

- merge `browser.ts` exports into main `Typesense.ts` file - update tsup config to use single entry point - simplify export pattern for core modules - streamline type exports

build: enable tree shaking for browser bundle

02eed40

- add explicit `treeshake` flag in tsup config - set browser-specific mainFields for module resolution - consolidate build optimization settings

build: include source files in npm package

ce41977

- add `src` directory to published files in `package.json` - remove redundant browser file cleanup step - expand package export configuration in `package.json` to include unminified versions of the browser bundle

chore: build artifacts

a5d6a4c

docs: update readme with search-only client guide

d5afb34

- add documentation for `SearchClient` browser usage - clarify commonjs and esm bundle formats - update build tool information from browserify to tsup

build: minify browser bundle by default

7ca86a5

build: expose only lib and dist on package

c969776

build: rename entrypoint from Typesense.ts to index.ts for parcel

9eb89cd

- avoid module resolution failures from parcel not respecting the `exports` field

fix(documents): throw on empty lists of documents

68f42a9

test(documents): add tests for empty document validation

e5aaf4b

- add test for empty array input - add test for empty string input - add test for null input - add test for undefined input

chore: fix import paths in tests

c9aab29

Merge branch 'master' into minified-bundle

491d002

chore: remove webpack from dependencies

1d7088f

tharropoulos added 2 commits May 9, 2025 14:25

Merge branch 'master' of github.com:typesense/typesense-js into minif…

c842363

…ied-bundles

fix(test): fix import to use barrel export

e9f09aa

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

Migrate build system to esbuild #261

Migrate build system to esbuild #261

Uh oh!

tharropoulos commented Feb 5, 2025

Uh oh!

jasonbosco left a comment

Uh oh!

tharropoulos commented Feb 7, 2025

Uh oh!

tharropoulos commented May 9, 2025

Uh oh!

Uh oh!

Uh oh!

Migrate build system to esbuild #261

Are you sure you want to change the base?

Migrate build system to esbuild #261

Uh oh!

Conversation

tharropoulos commented Feb 5, 2025

Change Summary

What is this?

Changes

Build System Updates:

Package Configuration:

Dependencies:

Type System Improvements:

Code Improvements:

Context

PR Checklist

Uh oh!

jasonbosco left a comment

Choose a reason for hiding this comment

Uh oh!

tharropoulos commented Feb 7, 2025

Uh oh!

tharropoulos commented May 9, 2025

Uh oh!

Uh oh!