chili3d 0.6.1 → 0.6.2

package/README.md

@@ -1,184 +1,23 @@
-# Chili3D
+# chili3d
 
-A web-based 3D CAD application for online model design and editing.
+3D建模引擎
 
-![Screenshot](./screenshots/screenshot.png)
+## 安装
 
-## Overview
+npm install chili3d
 
-[Chili3D](https://chili3d.com) is an [open-source](https://github.com/xiangechen/chili3d), browser-based 3D CAD (Computer-Aided Design) application built with TypeScript. It achieves near-native performance by compiling OpenCascade (OCCT) to WebAssembly and integrating with Three.js, enabling powerful online modeling, editing, and rendering—all without the need for local installation.
+## 使用
 
-You can access Chili3D online at:
+import { ChiliApplication } from 'chili';
 
-- Official website: [chili3d.com](https://chili3d.com)
-- Cloudflare deployment: [chili3d.pages.dev](https://chili3d.pages.dev)
+// 创建应用程序实例
+const app = new ChiliApplication();
 
-## Features
+// 初始化应用程序
+app.init();
 
-### Modeling Tools
+## 注意事项
 
-- **Basic Shapes**: Create boxes, cylinders, cones, spheres, pyramids, and more
-- **2D Sketching**: Draw lines, arcs, circles, ellipses, rectangles, polygons, and Bezier curves
-- **Advanced Operations**:
-    - Boolean operations (union, difference, intersection)
-    - Extrusion and revolution
-    - Sweeping and lofting
-    - Offset surfaces
-    - Section creation
-
-### Snapping and Tracking
-
-- **Object Snapping**: Precisely snap to geometric features (points, edges, faces)
-- **Workplane Snapping**: Snap to the current workplane for accurate planar operations
-- **Axis Tracking**: Create objects along tracked axes for precise alignment
-- **Feature Point Detection**: Automatically detect and snap to key geometric features
-- **Tracking Visualization**: Visual guides showing tracking lines and reference points
-
-### Editing Tools
-
-- **Modification**: Chamfer, fillet, trim, break, split
-- **Transformation**: Move, rotate, mirror
-- **Advanced Editing**:
-    - Feature removal
-    - Sub-shape manipulation
-    - Explode compound objects
-
-### Measurement Tools
-
-- Measure angles and lengths
-- Calculate the sum of length, area, and volume
-
-### Document Management
-
-- Create, open, and save documents
-- Full undo/redo stack with transaction history
-- Import/export of industry-standard formats (STEP, IGES, BREP)
-
-### User Interface
-
-- Office-style interface with contextual command organization
-- Hierarchical assembly management with flexible grouping capabilities
-- Dynamic workplane support
-- 3D viewport with camera controls
-- Camera position recall
-
-### Localization
-
-- **Multi-Language Interface**: Built-in internationalization (i18n) supporting seamless adaptation to global user bases
-- **Current Languages**: Chinese & English; contributions for additional languages are welcome
-
-## Technology Stack
-
-- **Frontend**: TypeScript, Three.js
-- **3D Engine**: OpenCascade (via WebAssembly)
-- **Build Tools**: Rspack
-- **Testing**: Jest
-
-## Change Log
-
-You can view the full change log [here](https://github.com/xiangechen/chili3d/releases).
-
-For Chinese users, you can also browse the [media](https://space.bilibili.com/539380032/lists/3108412?type=season).
-
-## Getting Started
-
-### Prerequisites
-
-- Node.js
-- npm
-
-### Installation
-
-1. Clone the repository
-
-    ```bash
-    git clone https://github.com/xiangechen/chili3d.git
-    cd chili3d
-    ```
-
-2. Install dependencies
-
-    ```bash
-    npm install
-    ```
-
-### Development
-
-Start the development server:
-
-```bash
-npm run dev # Launches at http://localhost:8080
-```
-
-### Building
-
-Build the application:
-
-```bash
-npm run build
-```
-
-### Building wasm
-
-if you want to build wasm by yourself, you can use the following commands:
-
-1. Set up WebAssembly dependencies(if you have not installed them yet)
-
-    ```bash
-    npm run setup:wasm
-    ```
-
-2. Build the WebAssembly module:
-
-    ```bash
-    npm run build:wasm
-    ```
-
-## Development Status
-
-⚠️ **Early Development Notice**
-
-Chili3D is currently in active alpha development. Key considerations:
-
-- Core APIs may undergo breaking changes
-- Essential features are under implementation
-- Documentation is being progressively developed
-
-## Contributing
-
-We welcome contributions in the form of code, bug reports, or feedback. Please feel free to submit pull requests or open issues.
-
-## Contact
-
-- **Discussions**: Join our [GitHub discussions](https://github.com/xiangechen/chili3d/discussions) for general chat or questions
-- **Issues**: Use [GitHub issues](https://github.com/xiangechen/chili3d/issues) to report public suggestions or bugs
-- **Email**: Contact us privately at xiangetg@msn.cn
-
-## License
-
-Distributed under the GNU Affero General Public License v3.0 (AGPL-3.0). For commercial licensing options, contact xiangetg@msn.cn
-
-Full license details: [LICENSE](LICENSE)
-
-## Warning
-
-Chili3d uses [Microsoft Clarity](https://clarity.microsoft.com) for growth analytics. To disable data collection:
-
-1. Open public/index.html
-2. Delete lines 11-17 containing this code:
-
-```
-<script type="text/javascript">
-    (function(c,l,a,r,i,t,y){
-        c[a]=c[a]||function(){(c[a].q=c[a].q||[]).push(arguments)};
-        t=l.createElement(r);t.async=1;t.src="https://www.clarity.ms/tag/"+i;
-        y=l.getElementsByTagName(r)[0];y.parentNode.insertBefore(t,y);
-    })(window, document, "clarity", "script", "***");
-</script>
-```
-
-This software is provided "AS IS," and the authors and contributors hereby disclaim all express and implied warranties. The user shall bear full responsibility for any and all risks and potential consequences arising from the use of this software. Such risks and consequences include, but are not limited to:
-
-1. Data loss, system failures, or any direct or indirect damages;
-2. Conduct violating applicable laws or regulations resulting from software usage and its consequences;
-3. All liabilities arising from the software’s use for illegal purposes or activities.
+1. 这是一个TypeScript项目，需要在TypeScript环境中使用
+2. 需要配置TypeScript编译器支持路径映射和模块解析
+3. 建议使用webpack或rspack进行构建

package/{packages/chili → chili}/package.json

@@ -3,7 +3,11 @@
   "version": "0.6.1",
   "description": "",
   "main": "src/index.ts",
-  "devDependencies": {
+  "types": "src/index.ts",
+  "files": [
+    "src/"
+  ],
+  "dependencies": {
     "chili-core": "*",
     "chili-geo": "*",
     "chili-vis": "*"

package/{packages/chili-builder → chili-builder}/package.json

@@ -3,7 +3,11 @@
   "version": "0.6.1",
   "description": "",
   "main": "src/index.ts",
-  "devDependencies": {
+  "types": "src/index.ts",
+  "files": [
+    "src/"
+  ],
+  "dependencies": {
     "chili": "*",
     "chili-i18n": "*",
     "chili-three": "*",

package/{packages/chili-controls → chili-controls}/package.json

@@ -3,7 +3,11 @@
   "version": "0.6.1",
   "description": "",
   "main": "src/index.ts",
-  "devDependencies": {
+  "types": "src/index.ts",
+  "files": [
+    "src/"
+  ],
+  "dependencies": {
     "chili-core": "*"
   }
 }

package/{packages/chili-core → chili-core}/package.json

@@ -3,5 +3,9 @@
   "version": "0.6.1",
   "description": "",
   "main": "src/index.ts",
-  "devDependencies": {}
+  "types": "src/index.ts",
+  "files": [
+    "src/"
+  ],
+  "dependencies": {}
 }

package/{packages/chili-geo → chili-geo}/package.json

@@ -3,7 +3,11 @@
   "version": "0.6.1",
   "description": "",
   "main": "src/index.ts",
-  "devDependencies": {
+  "types": "src/index.ts",
+  "files": [
+    "src/"
+  ],
+  "dependencies": {
     "chili-core": "*"
   }
 }

package/{packages/chili-i18n → chili-i18n}/package.json

@@ -3,7 +3,11 @@
   "version": "0.6.1",
   "description": "",
   "main": "src/index.ts",
-  "devDependencies": {
+  "types": "src/index.ts",
+  "files": [
+    "src/"
+  ],
+  "dependencies": {
     "chili-core": "*"
   }
 }

package/{packages/chili-storage → chili-storage}/package.json

@@ -3,7 +3,11 @@
   "version": "0.6.1",
   "description": "",
   "main": "src/index.ts",
-  "devDependencies": {
+  "types": "src/index.ts",
+  "files": [
+    "src/"
+  ],
+  "dependencies": {
     "chili-core": "*"
   }
 }

package/{packages/chili-three → chili-three}/package.json

@@ -3,7 +3,11 @@
   "version": "0.6.1",
   "description": "",
   "main": "src/index.ts",
-  "devDependencies": {
+  "types": "src/index.ts",
+  "files": [
+    "src/"
+  ],
+  "dependencies": {
     "@types/three": "0.181.0",
     "chili-core": "*",
     "chili-vis": "*",

package/{packages/chili-ui → chili-ui}/package.json

@@ -3,7 +3,11 @@
   "version": "0.6.1",
   "description": "",
   "main": "src/index.ts",
-  "devDependencies": {
+  "types": "src/index.ts",
+  "files": [
+    "src/"
+  ],
+  "dependencies": {
     "chili-core": "*",
     "chili-controls": "*",
     "chili-geo": "*",

package/{packages/chili-vis → chili-vis}/package.json

@@ -3,7 +3,11 @@
   "version": "0.6.1",
   "description": "",
   "main": "src/index.ts",
-  "devDependencies": {
+  "types": "src/index.ts",
+  "files": [
+    "src/"
+  ],
+  "dependencies": {
     "chili-core": "*"
   }
 }

package/{packages/chili-wasm → chili-wasm}/package.json

@@ -4,7 +4,11 @@
   "description": "",
   "main": "src/index.ts",
   "type": "module",
-  "devDependencies": {
+  "types": "src/index.ts",
+  "files": [
+    "src/"
+  ],
+  "dependencies": {
     "chili-core": "*"
   }
 }

package/{packages/chili-web → chili-web}/package.json

@@ -3,7 +3,11 @@
   "version": "0.6.1",
   "description": "",
   "main": "src/index.ts",
-  "devDependencies": {
+  "types": "src/index.ts",
+  "files": [
+    "src/"
+  ],
+  "dependencies": {
     "chili-builder": "*"
   }
 }

package/package.json

@@ -1,49 +1,19 @@
 {
-    "name": "chili3d",
-    "version": "0.6.1",
-    "description": "",
-    "documentVersion": "0.7",
-    "author": "仙阁",
-    "scripts": {
-        "build": "rspack build",
-        "build:types": "tsc --project tsconfig.build.json",
-        "build:wasm": "cd cpp && cmake --preset release && cmake --build --preset release",
-        "build:all": "npm run build:types && npm run build",
-        "check": "biome check --write",
-        "dev": "rspack dev",
-        "format": "biome check --write . && npx clang-format --style=Webkit --sort-includes -i ./cpp/src/**",
-        "preview": "rspack preview",
-        "release": "node scripts/release.mjs",
-        "setup:wasm": "node scripts/setup_wasm_deps.mjs",
-        "test": "rstest",
-        "testc": "rstest --coverage"
-    },
-    "simple-git-hooks": {
-        "pre-commit": "npx lint-staged"
-    },
-    "lint-staged": {
-        "*.{ts,js,css,json,md,mjs}": [
-            "biome check --write"
-        ],
-        "*.{c,h,cxx,hxx,cpp,hpp}": [
-            "clang-format --style=Webkit --sort-includes -i"
-        ]
-    },
-    "workspaces": [
-        "packages/*"
-    ],
-    "devDependencies": {
-        "@biomejs/biome": "2.3.6",
-        "@rspack/cli": "1.6.3",
-        "@rspack/core": "1.6.3",
-        "@rstest/core": "^0.6.5",
-        "@rstest/coverage-istanbul": "^0.0.5",
-        "clang-format": "^1.8.0",
-        "fork-ts-checker-webpack-plugin": "9.1.0",
-        "happy-dom": "^20.0.10",
-        "lint-staged": "16.2.6",
-        "simple-git-hooks": "2.13.1",
-        "typescript": "5.9.3",
-        "typescript-plugin-css-modules": "^5.2.0"
-    }
-}
+  "name": "chili3d",
+  "version": "0.6.2",
+  "description": "3D建模引擎",
+  "documentVersion": "0.7",
+  "author": "仙阁",
+  "private": false,
+  "main": "packages/chili/src/index.ts",
+  "types": "packages/chili/src/index.ts",
+  "keywords": [
+    "3d",
+    "modeling",
+    "cad"
+  ],
+  "license": "MIT",
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org/"
+  }
+}

package/.github/workflows/main.yml

@@ -1,26 +0,0 @@
-name: Test
-
-on:
-    push:
-        branches: ["main"]
-    pull_request:
-        branches: ["main"]
-
-jobs:
-    test-and-deploy:
-        runs-on: ubuntu-latest
-
-        steps:
-            - name: Checkout repository
-              uses: actions/checkout@v4
-
-            - name: Setup node
-              uses: actions/setup-node@v4
-              with:
-                  node-version: 24
-
-            - name: Install dependencies
-              run: npm install
-
-            - name: Run unit tests
-              run: npm run test

package/.vscode/c_cpp_properties.json

@@ -1,30 +0,0 @@
-{
-    "configurations": [
-        {
-            "name": "Mac",
-            "includePath": ["${workspaceFolder}/**"],
-            "cStandard": "c17",
-            "cppStandard": "c++17",
-            "compilerPath": "/usr/bin/clang",
-            "intelliSenseMode": "macos-clang-arm64"
-        },
-        {
-            "name": "Linux",
-            "includePath": ["${workspaceFolder}/**"],
-            "cStandard": "c17",
-            "cppStandard": "c++17",
-            "compilerPath": "/usr/bin/gcc",
-            "intelliSenseMode": "gcc-x64"
-        },
-        {
-            "name": "Win32",
-            "includePath": ["${workspaceFolder}/**"],
-            "cStandard": "c17",
-            "cppStandard": "c++17",
-            "compilerPath": "${default}",
-            "intelliSenseMode": "windows-msvc-x64"
-        }
-    ],
-    "enableConfigurationSquiggles": true,
-    "version": 4
-}

package/.vscode/launch.json

@@ -1,21 +0,0 @@
-{
-    "version": "0.2.0",
-    "configurations": [
-        {
-            "name": "Debug(Test)",
-            "type": "node",
-            "request": "launch",
-            "program": "${workspaceFolder}/node_modules/@rstest/core/bin/rstest.js",
-            "args": ["run", "${file}"],
-            "console": "integratedTerminal",
-            "internalConsoleOptions": "neverOpen",
-            "skipFiles": ["<node_internals>/**"]
-        },
-        {
-            "name": "Debug",
-            "type": "msedge",
-            "request": "launch",
-            "url": "http://localhost:8080/"
-        }
-    ]
-}

package/.vscode/settings.json

@@ -1,8 +0,0 @@
-{
-    "typescript.tsdk": "node_modules/typescript/lib",
-    "editor.codeActionsOnSave": {
-        "source.organizeImports": "explicit"
-    },
-    "editor.inlineSuggest.showToolbar": "onHover",
-    "cmake.sourceDirectory": "${workspaceFolder}/cpp"
-}

package/Dockerfile

@@ -1,7 +0,0 @@
-FROM node:alpine AS builder
-WORKDIR '/app'
-COPY . .
-RUN npm install && npm run build
-
-FROM nginx:alpine
-COPY --from=builder /app/dist /usr/share/nginx/html