core-js-builder 3.27.2 → 3.29.0

package/README.md

@@ -6,6 +6,9 @@
 
 </div>
 
+**I highly recommend reading this: [So, what's next?](https://github.com/zloirock/core-js/blob/master/docs/2023-02-14-so-whats-next.md)**
+---
+
 For some cases could be useful to exclude some `core-js` features or generate a polyfill for target engines. This API helps conditionally include or exclude certain parts of [`core-js`](https://github.com/zloirock/core-js) and build for targets. `modules`, `exclude` and `targets` options are specified in [the `core-js-compat` format](https://github.com/zloirock/core-js/tree/master/packages/core-js-compat).
 
 ```js
@@ -32,3 +35,5 @@ const bundle = await builder({
   filename: PATH_TO_MY_COREJS_BUNDLE,
 });
 ```
+
+ℹ️ When using TypeScript, make sure to set `esModuleInterop` to `true`.

package/index.d.ts

@@ -0,0 +1,71 @@
+type StringOrRegExp = string | RegExp;
+
+type Modules = StringOrRegExp | readonly StringOrRegExp[];
+
+type Target =
+  | 'android'
+  | 'bun'
+  | 'chrome'
+  | 'chrome-android'
+  | 'deno'
+  | 'edge'
+  | 'electron'
+  | 'firefox'
+  | 'firefox-android'
+  | 'hermes'
+  | 'ie'
+  | 'ios'
+  | 'node'
+  | 'opera'
+  | 'opera-android'
+  | 'phantom'
+  | 'quest'
+  | 'react-native'
+  | 'rhino'
+  | 'safari'
+  | 'samsung';
+
+type BrowserslistQuery = string | ReadonlyArray<string>;
+
+type Environments = {
+  [target in Target]?: string | number;
+};
+
+type Targets = Environments & {
+  browsers?: Environments | BrowserslistQuery,
+  esmodules?: boolean,
+};
+
+type Format = 'bundle' | 'esm' | 'cjs';
+
+type SummaryEntry = boolean | {
+  size?: boolean,
+  modules?: boolean,
+};
+
+type Summary = {
+  /** in the console, you could specify required parts or set `true` for enable all of them */
+  comment?: SummaryEntry,
+  /** in the comment, you could specify required parts or set `true` for enable all of them */
+  console?: SummaryEntry,
+};
+
+type Options = {
+  /** entry / module / namespace / an array of them, by default - all `core-js` modules */
+  modules?: Modules,
+  /** a blacklist, entry / module / namespace / an array of them, by default - empty list */
+  exclude?: Modules,
+  /** optional browserslist or core-js-compat format query */
+  targets?: Targets | BrowserslistQuery,
+  /** output format, 'bundle' by default, can be 'cjs' or 'esm', and in this case
+   *  the result will not be bundled and will contain imports of required modules */
+  format?: Format,
+  /** optional target filename, if it's missed a file will not be created */
+  filename?: string,
+  /** shows summary for the bundle, disabled by default */
+  summary?: Summary,
+};
+
+declare function builder(options?: Options): Promise<string>;
+
+export = builder;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "core-js-builder",
-  "version": "3.27.2",
+  "version": "3.29.0",
   "description": "core-js builder",
   "repository": {
     "type": "git",
@@ -19,9 +19,10 @@
   },
   "sideEffects": false,
   "main": "index.js",
+  "types": "index.d.ts",
   "dependencies": {
-    "core-js": "3.27.2",
-    "core-js-compat": "3.27.2",
+    "core-js": "3.29.0",
+    "core-js-compat": "3.29.0",
     "mkdirp": ">=0.5.5 <1",
     "webpack": ">=4.46.0 <5"
   },