susee 2.0.3 → 2.0.5

package/README.md

@@ -3,16 +3,17 @@
 <div align="center">
 <img src="https://susee.phothin.dev/logo/susee-bg-white.webp" width="160" height="160" alt="susee" />
   <h1>Susee</h1>
+  <p>A high-performance TypeScript library bundler</p>
 </div>
 <!-- markdownlint-enable MD033 -->
 
 [![NPM][nodei_img]][nodei_url]
 
-[![npm version][npm_v_img]][npm_v_url] [![license][license_img]](LICENSE)[![publish to npm][publish_npm_svg]][publish_npm][![OpenSSF Baseline](https://www.bestpractices.dev/projects/13115/baseline)](https://www.bestpractices.dev/projects/13115) [![OpenSSF Best Practices](https://www.bestpractices.dev/projects/13115/badge)](https://www.bestpractices.dev/projects/13115)
+[![npm version][npm_v_img]][npm_v_url] [![license][license_img]](LICENSE)[![OpenSSF Baseline](https://www.bestpractices.dev/projects/13115/baseline)](https://www.bestpractices.dev/projects/13115) [![OpenSSF Best Practices](https://www.bestpractices.dev/projects/13115/badge)](https://www.bestpractices.dev/projects/13115)
 
-## About
+## Overview
 
-A **TypeScript-first** bundler designed specifically for **library packages** that delivers **fast builds**, **type safety**, and **modern JavaScript output** with minimal configuration.
+`susee` is a **TypeScript-first bundler** specialized for library packages.Unlike general-purpose bundlers, `susee` focuses on consolidating a package's local TypeScript dependency tree into consolidated source units and compiling them into dual-format artifacts (ESM and CommonJS) using a high-performance `Rust` core.
 
 > [!NOTE]
 >
@@ -24,11 +25,9 @@ A **TypeScript-first** bundler designed specifically for **library packages** th
 
 ## Key Features
 
-✅ **Rust-powered core** — Bundler, compiler, and minifier run natively via N-API
+✅ **Native Performance via N-API and Rust** — Key native components: Bundler , Compiler, Minifier, N-API Bridge
 
-✅ **TypeScript-first** — Built for maximum type safety
-
-✅ **Dual Output** — Generate both ESM and CommonJS formats automatically
+✅ **Dual-Format Module Output** — Generate both ESM and CommonJS formats automatically
 
 ✅ **Duplicate Declaration Detection** — Fails fast when bundled files contain conflicting top-level declarations
 
@@ -171,9 +170,9 @@ suseeBuild({
 suseeBuild();
 ```
 
-| Parameter       | Type                        | Required | Default | Description                                      |
-| --------------- | --------------------------- | -------- | ------- | ------------------------------------------------ |
-| `config`        | `SuSeeConfig \| undefined`   | No       | —       | Build options. If omitted, loads config file.    |
+| Parameter | Type                       | Required | Default | Description                                   |
+| --------- | -------------------------- | -------- | ------- | --------------------------------------------- |
+| `config`  | `SuSeeConfig \| undefined` | No       | —       | Build options. If omitted, loads config file. |
 
 ### `cliBuild(args)`
 
@@ -185,9 +184,9 @@ import { cliBuild } from "susee";
 cliBuild(process.argv.slice(2));
 ```
 
-| Parameter | Type         | Required | Description                                                        |
-| --------- | ------------ | -------- | ------------------------------------------------------------------ |
-| `args`    | `string[]`   | Yes      | CLI arguments (typically `process.argv.slice(2)`).               |
+| Parameter | Type       | Required | Description                                        |
+| --------- | ---------- | -------- | -------------------------------------------------- |
+| `args`    | `string[]` | Yes      | CLI arguments (typically `process.argv.slice(2)`). |
 
 ### `suseeBundler(entry)`
 
@@ -222,9 +221,9 @@ enum OutputFormat {
 ```ts
 interface SuSeeConfig {
   entryPoints: EntryPoint[];
-  outDir?: string;                 // default: "dist"
+  outDir?: string; // default: "dist"
   allowUpdatePackageJson?: boolean; // default: false
-  minify?: boolean;                // default: false
+  minify?: boolean; // default: false
 }
 ```
 
@@ -233,10 +232,10 @@ interface SuSeeConfig {
 ```ts
 interface EntryPoint {
   entry: string;
-  exportPath: string;             // "." or "./sub/path"
-  format?: OutputFormat[];         // default: ["esm"]
+  exportPath: string; // "." or "./sub/path"
+  format?: OutputFormat[]; // default: ["esm"]
   tsconfigFilePath?: string | null; // default: null
-  warning?: boolean;               // default: false
+  warning?: boolean; // default: false
 }
 ```
 
@@ -431,31 +430,31 @@ The config file uses the **JSONC** format (JSON with comments) and must be named
       "exportPath": ".",
       "format": ["esm", "commonjs"],
       "tsconfigFilePath": null,
-      "warning": false
-    }
+      "warning": false,
+    },
   ],
   // Output directory (default: "dist")
   "outDir": "dist",
   // Update package.json fields from build output (default: false)
   "allowUpdatePackageJson": false,
   // Minify output JS with the oxc minifier (default: false)
-  "minify": true
+  "minify": true,
 }
 ```
 
 ### Config schema
 
-| Field                    | Type         | Required | Default     | Description                                  |
-| ----------------------- | ------------ | -------- | ----------- | -------------------------------------------- |
-| `entryPoints`           | `EntryPoint[]` | Yes    | —           | List of entry points to build.               |
-| `outDir`                | `string`     | No       | `"dist"`   | Root output directory.                       |
-| `allowUpdatePackageJson`| `boolean`    | No       | `false`    | Update package.json from build output.       |
-| `minify`                | `boolean`    | No       | `false`    | Minify emitted JS with the oxc minifier.     |
-| `entryPoints[].entry`   | `string`     | Yes      | —           | Entry file path.                             |
-| `entryPoints[].exportPath` | `string`   | Yes      | —           | Package export path (`.` or `./sub`).        |
-| `entryPoints[].format`  | `string[]`   | No       | `["esm"]`  | Output formats: `"esm"`, `"commonjs"`.      |
-| `entryPoints[].tsconfigFilePath` | `string\|null` | No | `null` | Custom tsconfig path.                   |
-| `entryPoints[].warning` | `boolean`    | No       | `false`    | Treat dependency warnings as fatal.          |
+| Field                            | Type           | Required | Default   | Description                              |
+| -------------------------------- | -------------- | -------- | --------- | ---------------------------------------- |
+| `entryPoints`                    | `EntryPoint[]` | Yes      | —         | List of entry points to build.           |
+| `outDir`                         | `string`       | No       | `"dist"`  | Root output directory.                   |
+| `allowUpdatePackageJson`         | `boolean`      | No       | `false`   | Update package.json from build output.   |
+| `minify`                         | `boolean`      | No       | `false`   | Minify emitted JS with the oxc minifier. |
+| `entryPoints[].entry`            | `string`       | Yes      | —         | Entry file path.                         |
+| `entryPoints[].exportPath`       | `string`       | Yes      | —         | Package export path (`.` or `./sub`).    |
+| `entryPoints[].format`           | `string[]`     | No       | `["esm"]` | Output formats: `"esm"`, `"commonjs"`.   |
+| `entryPoints[].tsconfigFilePath` | `string\|null` | No       | `null`    | Custom tsconfig path.                    |
+| `entryPoints[].warning`          | `boolean`      | No       | `false`   | Treat dependency warnings as fatal.      |
 
 ---
 

package/bin/susee

@@ -1,4 +1,3 @@
 #!/usr/bin/env node
 
-var {cliBuild} = require("../index.js")
-cliBuild(process.argv.slice(2));
+import "../dist/cli/index.mjs";

package/dist/index.d.mts

@@ -0,0 +1,92 @@
+import { type CheckOptions } from '@suseejs/susee_bundler';
+import { type MinifyOptions } from 'oxc-minify';
+type OutputFormat = ('commonjs' | 'esm')[];
+interface EntryPoint {
+    /**
+    * Entry of file path of package
+    *
+    * required
+    */
+    entry: string;
+    /**
+    * Info for output
+    *
+    * required
+    */
+    /**
+    *  path for package
+    *
+    * required
+    */
+    exportPath: '.' | `./${string}`;
+    /**
+    * Output module type of package
+    *
+    * default - [esm]
+    */
+    format?: OutputFormat;
+    /**
+    * Custom tsconfig.json path for package typescript compiler options
+    *
+    * Priority -
+    *  1. this custom tsconfig.json
+    *  2. tsconfig.json at root directory
+    *  3. default compiler options of susee
+    *
+    * default - undefined
+    *
+    */
+    tsconfigFilePath?: string | undefined;
+    /**
+    * Lint checks to run on the bundled output.
+    *
+    * default - { checkAnonymous: false, checkDefaultExports: false, checkNpmInstalled: false }
+    */
+    checks?: CheckOptions;
+    /**
+    * Minify the bundled output.
+    *
+    * Pass `true` for default minification, or an object with custom `MinifyOptions`.
+    *
+    * default - false
+    */
+    minify?: boolean | {
+        options: MinifyOptions;
+    };
+}
+/**
+* Configuration for Susee Bundler
+*/
+interface SuSeeConfig {
+    /**
+    * Array of entry points object
+    *
+    * required
+    */
+    entryPoints: EntryPoint[];
+    /**
+    * Out directory
+    *
+    * default - dist
+    */
+    outDir?: string;
+    /**
+    * Allow bundler to update your package.json.
+    *
+    * default - false
+    */
+    allowUpdatePackageJson?: boolean;
+}
+/**
+* Run a Susee build.
+*
+* Resolution order:
+* 1. Use `options` when provided.
+* 2. Otherwise try loading root config via `finalSuseeConfig()`.
+*
+* If neither source is available, this logs an error and exits with code 1.
+*/
+declare function build(options?: SuSeeConfig): any;
+export type { SuSeeConfig };
+export { build };
+//# sourceMappingURL=index.d.ts.map