susee 0.1.0 → 0.1.2

package/LICENSE

@@ -1,19 +1,201 @@
-ISC License
-
-Copyright 2025 Pho Thin Maung<phothinmg@disroot.org>
-
-Permission to use, copy, modify, and/or distribute 
-this software for any purpose with or without fee is 
-hereby granted, provided that the above copyright 
-notice and this permission notice appear in all copies.
-
-THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR 
-DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE 
-INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY 
-AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE 
-FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL 
-DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS 
-OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF 
-CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING 
-OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF 
-THIS SOFTWARE.
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -1,78 +1,111 @@
 <div align="center">
-	<img src="https://github.com/phothinmg/ptmbox/blob/main/kadown.svg" width="160" height="160" alt="susee" />
-	<h1>susee</h1>
+<img src="https://pub-d94f06e647584b8496cac0d43a6fecfb.r2.dev/susee/susee.webp" width="160" height="160" alt="susee" />
+  <h1>susee</h1>
 </div>
 
-Tiny TypeScript bundler that emits CommonJS, ESM, and types in one build. Includes post-process hooks like banner injection and minification.
+susee is a small TypeScript bundler that collates a package's local dependency tree, then emits compiled artifacts for ESM and/or CommonJS along with type definitions. It can also update `package.json` exports automatically for main and subpath exports.
 
-## Features
-
-- Bundles a TypeScript entry with its dependency tree
-- Outputs CommonJS (.cjs) and ESM (.mjs) builds with type declarations
-- Auto-writes `package.json` fields (`main`, `module`, `types`, `exports`)
-- Post-process hooks (sync/async) for code transforms
-- Optional helper hooks: banner text and terser minify
+**Key points**
+- Produces ESM (`.mjs`) and/or CommonJS (`.cjs`) outputs and corresponding type files (`.d.mts` / `.d.cts`).
+- Merges local dependency files into a single bundled input for the TypeScript compiler.
+- Supports simple plugin hooks at multiple stages: `dependency`, `pre-process`, and `post-process`.
+- When enabled, updates `package.json` fields (`type`, `main`, `module`, `types`, `exports`) for the main export and merges subpath exports.
 
 ## Installation
 
 ```bash
-npm i susee
+npm install susee
 ```
 
 ## Usage
 
-```ts
-import susee from "susee";
-import bannerText from "susee/banner-text";
-import minify from "susee/minify";
-
-const license = "/*! My Library */";
-
-await susee.build({
-	entry: "src/index.ts",
-	outDir: "dist",
-	target: "both",
-	defaultExportName: "myLib",
-	hooks: [bannerText(license), minify()],
-});
+CLI (global or npx):
+
+```bash
+npx susee
 ```
 
-## API
+programmatic (exports):
 
-### `susee.build(options)`
+```ts
+import { susee } from "susee";
 
-Builds the given entry file and writes outputs plus `package.json` updates.
+await susee();
+```
 
-**Options**
+## Configuration
 
-- `entry` (string, required): Entry file path.
-- `target` (`"commonjs" | "esm" | "both"`, default: `"both"`): Output format.
-- `defaultExportName` (string | undefined): Default export name used for CommonJS conversion.
-- `outDir` (string, default: `"dist"`): Output directory.
-- `isMainExport` (boolean, default: `true`): If `false`, adds a subpath export.
-- `replaceWithBlank` (string[], default: `[]`): Strings to remove from generated output.
-- `hooks` (`PostProcessHook[]`, default: `[]`): Post-processing hooks applied per output file.
+Place a `susee.config.ts` at your project root. The config defines entry points and optional hooks.
 
-### `PostProcessHook`
+Example `susee.config.ts`:
 
 ```ts
-type PostProcessHook =
-	| { async: true; func: (code: string, file?: string) => Promise<string> }
-	| { async: false; func: (code: string, file?: string) => string };
+import type { SuSeeConfig } from "susee";
+
+const config: SuSeeConfig = {
+  entryPoints: [
+    {
+      entry: "src/index.ts",
+      exportPath: ".",
+      format: "both", // "esm" | "commonjs" | "both"
+      renameDuplicates: true,
+      outDir: "dist",
+    },
+  ],
+  postProcessHooks: [], // optional plugins
+  allowUpdatePackageJson: true,
+};
+
+export default config;
 ```
 
-## Subpath Exports
+Config summary:
+- `entryPoints`: array of entry definitions
+  - `entry` — path to entry file (required)
+  - `exportPath` — `.` or a subpath like `./feature`
+  - `format` — `esm` | `commonjs` | `both` (defaults to `esm`)
+  - `tsconfigFilePath` — optional custom tsconfig for that entry
+  - `renameDuplicates` — whether to auto-rename duplicate identifiers
+  - `outDir` — where compiled files will be written (e.g. `dist`)
+- `postProcessHooks` — array of `post-process` plugins (sync or async)
+- `allowUpdatePackageJson` — when true, `package.json` is updated with produced entry points
+
+## Plugins
 
-The package exposes two helper hooks:
+Plugins in the ecosystem have three common types:
+- `dependency` — transform dependency list before bundling
+- `pre-process` — modify the joined bundle text before compilation
+- `post-process` — modify emitted output files
 
-- `susee/banner-text` — prepends a banner string to `.js` outputs.
-- `susee/minify` — minifies `.js` outputs using `terser`.
+Plugins may be provided as objects or factories (functions returning the plugin). They may be synchronous or async — the bundler handles both.
 
-## Notes
+## package.json updates
 
-- If both named and default exports exist in the entry, CommonJS output keeps the default export and drops named exports.
-- For subpath builds, `outDir` should include a subfolder (e.g. `dist/banner-text`).
+When `allowUpdatePackageJson` is enabled, susee will:
+- set `type` to `module` (to ensure ESM compatibility)
+- add/update `main`, `module`, `types` and `exports` for the main export when building the package root
+- merge subpath exports for non-root `exportPath`s without overwriting unrelated exports
+
+Output file name hints (produced by the compiler):
+- ESM JS -> `.mjs`
+- ESM types -> `.d.mts`
+- CJS JS -> `.cjs`
+- CJS types -> `.d.cts`
+
+## Limitations & notes
+- The bundler only processes local TypeScript files and does not bundle `node_modules` packages.
+- The entry file should be an ESM-compatible TypeScript file.
+- Exports from the entry file are not removed — only dependency exports may be stripped during bundling.
+
+## Contributing and tests
+
+- Build and run tests with the repo scripts (see `package.json`):
+
+```bash
+npm run build
+npm test
+```
 
 ## License
 
-ISC
+Apache-2.0

package/bin/index.mjs

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+import  {susee} from "../dist/index.mjs";
+await susee();