customforge 0.1.0-alpha.0

package/CHANGELOG.md

@@ -0,0 +1,27 @@
+# Changelog
+
+All notable changes to CustomForge will be documented in this file
+
+## [Unreleased]
+
+## [0.1.0-alpha.0] - 2026-08-27
+
+### Added
+
+- ESM Library build configuration with source maps
+- TypeScript declaration and declaration map generation
+- Namespaced core stylesheet exported as `customforge/style.css`
+- Local package verification and npm consumer example
+- Versioned, Fabric-independent Design JSON types and runtime validation
+- Public `saveDesign()` and transactional `loadDesign()` methods
+- Design JSON save and load controls in the built-in and npm consumer demos
+
+### Changed
+
+- Fabric.js and Three.js are peer dependencies for Library consumers
+- Demo-only Lucide icons are development dependencies
+- `ProductCustomizer` no longer exposes its Fabric.js editor or Three.js viewer instances
+- Package version `0.1.0-alpha.0` is configured for public releases under the `alpha` dist-tag
+- Text and image objects remain fully inside the editor canvas while being added or transformed
+- The built-in demo product no longer includes the obstructive torus handle
+- Blob URL images are converted to persistent Data URLs when added

package/LICENSE

@@ -0,0 +1,201 @@
+                                 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

@@ -0,0 +1,299 @@
+<div align="center">
+
+# CustomForge
+
+**Turn a 2D texture canvas into a live 3D product preview**
+
+A lightweight, framework-agnostic prototype for building browser-based product customization experiences with Fabric.js and Three.js
+
+<p>
+  <img alt="TypeScript" src="https://img.shields.io/badge/TypeScript-strict-3178C6?logo=typescript&logoColor=white">
+  <img alt="Vite" src="https://img.shields.io/badge/Vite-8-646CFF?logo=vite&logoColor=white">
+  <img alt="Three.js" src="https://img.shields.io/badge/Three.js-r185-111111?logo=threedotjs&logoColor=white">
+  <img alt="Fabric.js" src="https://img.shields.io/badge/Fabric.js-7-DB4D6D">
+  <img alt="License" src="https://img.shields.io/badge/License-Apache%202.0-2F6F9F">
+</p>
+
+<p>
+  <strong>English</strong> |
+  <a href="./README.zh-CN.md">中文简体</a>
+</p>
+
+</div>
+
+---
+
+## What It Does
+
+CustomForge connects a familiar 2D design surface to a UV-mapped 3D model:
+
+- Add and edit text on a 2D texture canvas
+- Upload, move, scale, and rotate images
+- Preview every canvas change on a 3D product in real time
+- Load remote GLB/GLTF models and optional base textures
+- Select the customizable surface by mesh name
+- Rotate and zoom the 3D preview with OrbitControls
+- Export the composed texture as a PNG
+- Save and restore editable objects through versioned Design JSON
+
+The included workbench starts with a procedural cup, so the project works immediately without external assets
+
+## Repository Development
+
+Requirements: Node.js 22+ and pnpm 11+
+
+```bash
+pnpm install
+pnpm dev
+```
+
+Open the URL printed by Vite
+
+The built-in demo appears with a UV workspace on the left and a live 3D preview on the right
+
+## npm Alpha Package
+
+CustomForge is prepared for public alpha releases under the `alpha` dist-tag. The API and Design JSON Schema may change between alpha versions
+
+After the first release is published, install the current alpha and its peer dependencies with:
+
+```powershell
+pnpm add customforge@alpha
+pnpm add fabric three
+```
+
+For repository-independent verification before publishing, build and create the local package from the repository root:
+
+```powershell
+pnpm pack:local
+```
+
+The command builds JavaScript, TypeScript declarations, and core styles, checks the npm file list, and creates:
+
+```text
+customforge-0.1.0-alpha.0.tgz
+```
+
+Install that local package and its peer dependencies in an independent Vite TypeScript project:
+
+```powershell
+pnpm add D:\project\CustomForge\CustomForge\customforge-0.1.0-alpha.0.tgz
+pnpm add fabric three
+```
+
+The checked-in `examples/npm-consumer` project imports CustomForge only through this `.tgz`. Run `pnpm install --ignore-workspace` in that directory so pnpm installs it independently from the parent workspace
+
+## Load Your Product
+
+Choose **Load remote** in the demo and provide:
+
+| Field | Purpose |
+| --- | --- |
+| GLB / GLTF URL | URL of the UV-mapped 3D product model |
+| Base texture URL | Optional image shown underneath editable objects |
+| Customizable mesh | Name of the mesh that receives the live canvas texture |
+| Flip texture vertically | Corrects texture orientation when required by the model |
+
+UV coordinates are expected to be stored in the 3D model
+
+The optional texture image is the visual base layer, not a replacement for model UV data
+
+> [!IMPORTANT]
+> Remote models, textures, decals, and fonts must be served with CORS headers that allow the app origin
+>
+> A blocked or canvas-tainting resource may fail to load and can prevent PNG export
+
+## Basic Usage
+
+The framework-independent Library entry can be mounted into any two DOM containers:
+
+CustomForge is browser-only and must be initialized after its DOM containers are available
+
+The editor and viewer require two different containers; call `destroy()` when the page, host component, or instance is no longer in use to release Fabric, WebGL, observer, and event resources
+
+```html
+<div id="texture-editor"></div>
+<div id="product-viewer"></div>
+```
+
+```ts
+import { createCustomizer } from 'customforge'
+import 'customforge/style.css'
+
+const customizer = await createCustomizer({
+  editor: '#texture-editor',
+  viewer: '#product-viewer',
+  editorWidth: 1024,
+  editorHeight: 512,
+  product: {
+    modelUrl: 'https://example.com/product.glb',
+    textureUrl: 'https://example.com/base-texture.png',
+    surfaceMesh: 'PrintArea',
+    textureFlipY: false,
+  },
+})
+
+customizer.addText({
+  text: 'Hello world',
+  x: 120,
+  y: 180,
+  fontSize: 64,
+  color: '#172126',
+})
+
+await customizer.addImage({
+  src: 'https://example.com/logo.png',
+  x: 720,
+  y: 240,
+  width: 220,
+})
+
+window.addEventListener('beforeunload', () => customizer.destroy(), {
+  once: true,
+})
+```
+
+The public package uses the same root and style imports as the local `.tgz`; pin an exact alpha version when reproducible installs are required
+
+## Design JSON
+
+`saveDesign()` returns a Library-owned, JSON-safe document instead of exposing Fabric.js serialization. `loadDesign()` validates unknown input and restores the editable object stack asynchronously:
+
+```ts
+const design = customizer.saveDesign()
+localStorage.setItem('customforge-design', JSON.stringify(design))
+
+const savedDesign = localStorage.getItem('customforge-design')
+if (savedDesign) {
+  await customizer.loadDesign(JSON.parse(savedDesign))
+}
+```
+
+The current Schema version is `1`. It stores the logical canvas size and the text and image objects in back-to-front render order, including stable object IDs and center-based transforms
+
+Design JSON intentionally excludes the product model, target mesh, and base texture. A document can only be loaded into an editor with exactly the same logical width and height
+
+Loading is transactional: the current design remains unchanged unless the document validates and every referenced image loads successfully. Blob URL images are converted to Data URLs when added; remote image URLs remain URLs and must continue to satisfy browser CORS requirements when restored
+
+The Schema is still an alpha contract and may change in later alpha versions
+
+## Instance API
+
+| Method | Description |
+| --- | --- |
+| `addText(options)` | Add and select editable text, constrained to the canvas |
+| `addImage(options)` | Load and select an image, constrained to the canvas |
+| `deleteSelected()` | Remove the active object or selection |
+| `saveDesign()` | Return the current versioned Design JSON document |
+| `loadDesign(value)` | Validate and transactionally restore Design JSON |
+| `loadProduct(product)` | Replace the model, base texture, and target mesh |
+| `exportTexture(filename?)` | Download the composed texture as PNG |
+| `resetView()` | Restore the default 3D camera position |
+| `on(event, listener)` | Subscribe to instance events; returns an unsubscribe function |
+| `destroy()` | Release DOM events, Fabric state, and WebGL resources |
+
+Available events are `ready`, `change`, `selectionchange`, `status`, and `error`
+
+The initial alpha stability boundary is limited to the methods above, `createCustomizer`, `ProductCustomizer`, and the configuration, event, and Design JSON types exported from the package root
+
+`ProductCustomizer` does not expose its Fabric.js editor or Three.js viewer instances; consumers interact through the facade API
+
+Imports from `core`, `editor`, `viewer`, `bridge`, or any other undeclared package subpath are unsupported
+
+## Architecture
+
+```mermaid
+flowchart LR
+    A[Text and images] --> B[DesignEditor]
+    C[Base texture] --> B
+    B --> D[HTML Canvas]
+    D --> E[TextureBridge]
+    E --> F[Three.js CanvasTexture]
+    G[GLB / GLTF model] --> H[ProductViewer]
+    F --> H
+    H --> I[Customizable mesh]
+```
+
+```text
+ProductCustomizer
+|-- DesignEditor      Fabric.js rendering and object interaction
+|-- ProductViewer     Three.js scene, model, material, and camera
+`-- TextureBridge     Canvas-to-material synchronization
+```
+
+`ProductCustomizer` coordinates the modules while keeping Fabric.js and Three.js details behind a small instance API
+
+The demo UI uses Vanilla TypeScript; the core does not depend on Vue, React, or another UI framework
+
+## Model Contract
+
+The current prototype expects:
+
+- A GLB or GLTF model with valid UV coordinates
+- An uncompressed model that can be loaded by the standard Three.js `GLTFLoader`
+- A named mesh for the customizable surface, such as `PrintArea`
+- The target texture in the first material slot of that mesh
+- Remote asset URLs accessible under the browser's CORS policy
+
+The built-in demo follows the same `PrintArea` mesh convention
+
+## Project Structure
+
+```text
+src/
+|-- bridge/           Canvas and Three.js texture synchronization
+|-- core/             Public types, configuration, and DOM helpers
+|-- customizer/       Public instance orchestration
+|-- demo/             Runnable workbench UI
+|-- editor/           Fabric.js design surface
+|-- style.css         Public Library style entry
+|-- styles/           Library core styles
+|-- viewer/           Three.js product preview
+`-- index.ts          Framework-independent source entry
+
+examples/
+`-- npm-consumer/     Independent local .tgz consumer
+
+scripts/
+`-- verify-package.mjs  npm file and artifact boundary checks
+```
+
+## Development Commands
+
+```bash
+pnpm check       # TypeScript project check
+pnpm test        # Unit tests
+pnpm build       # Type-check and production build
+pnpm build:lib   # Build ESM, declarations, and core styles
+pnpm verify:package # Check dist and the npm file list
+pnpm pack:local  # Build, verify, and create the local .tgz
+pnpm release:check # Run checks, tests, package build, verification, and local pack
+pnpm preview     # Preview the production build
+```
+
+## Current Scope
+
+This is an early technical prototype
+
+The public API and design document format are not stable yet
+
+The current milestone intentionally focuses on one texture and one customizable mesh
+
+Public npm releases use the `alpha` dist-tag until the API and Design JSON contract are ready for a more stable channel
+
+Multi-surface products, undo/redo, and framework adapters are not implemented yet. Undo/redo is the next planned milestone and will build on the Design JSON snapshot contract
+
+## Technology
+
+- [Fabric.js](https://fabricjs.com/) for the 2D editing surface
+- [Three.js](https://threejs.org/) for model loading and real-time 3D rendering
+- [Vite](https://vite.dev/) for development and application builds
+- [TypeScript](https://www.typescriptlang.org/) with strict checking enabled
+
+## License
+
+CustomForge is licensed under the Apache License 2.0
+
+See [LICENSE](./LICENSE) for the full license terms
+
+Third-party dependencies and assets remain subject to their respective licenses