@omrips/viewstl 2.0.0-rc.1 → 2.0.0-rc.3

package/README.md

@@ -4,9 +4,34 @@
 
 Embed a viewer in your website, open local 3D files, inspect models and save the result. ViewSTL v2 uses its own renderer, with no Three.js runtime required. File parsing and geometry analysis run in workers, with memory limits and cancellation support.
 
-[Try the preview](https://preview.viewstl.com/) · [v2 usage and API notes](https://unpkg.com/@omrips/viewstl@2.0.0-rc.1/docs/v2-usage.md) · [Legacy plugin documentation](https://www.viewstl.com/plugin/)
+[Try the preview](https://preview.viewstl.com/) · [v2 usage and API notes](https://unpkg.com/@omrips/viewstl@2.0.0-rc.3/docs/v2-usage.md) · [Legacy plugin documentation](https://www.viewstl.com/plugin/)
 
-> **Preview release: 2.0.0-rc.1.** v2 is a new implementation, with documented differences from v1. Existing versions remain available at their original paths. Read the migration notes before updating an existing integration.
+> **Preview release: 2.0.0-rc.3.** v2 is a new implementation, with documented differences from v1. Existing versions remain available at their original paths. Read the migration notes before updating an existing integration.
+
+## Quick start
+
+Install with `npm install @omrips/viewstl@2.0.0-rc.3`, then copy the complete `node_modules/@omrips/viewstl/build/v2/` folder to `/viewstl-v2/` on your website.
+
+Paste these three lines into your page's `<body>`:
+
+```html
+<div id="viewer" style="height:500px"></div>
+<script src="/viewstl-v2/viewstl.min.js"></script>
+<script>new StlViewer(document.getElementById('viewer'), { models: [{ filename: 'model.stl' }] });</script>
+```
+
+Replace `model.stl` with your model's path and open the page over HTTP(S). That's it. You can also drag local files onto the viewer.
+
+## Quick start (Node.js)
+
+For server-side model analysis, install `npm install @omrips/viewstl@2.0.0-rc.3` and run:
+
+```js
+import { analyzeFile } from '@omrips/viewstl/node';
+const report = await analyzeFile('part.stl', { units: 'mm' });
+```
+
+Requires Node.js 20+. Workers and CAD assets load directly from the installed package. The result is a JSON-compatible report with dimensions, surface area, validated volume and mesh checks. STL, OBJ, 3MF, STEP and IGES are supported. See [server API and limits](https://unpkg.com/@omrips/viewstl@2.0.0-rc.3/docs/v2-usage.md#nodejs-model-analysis) for buffers, batch processing, cancellation and unit handling.
 
 ## What v2 can do
 
@@ -16,6 +41,7 @@ Embed a viewer in your website, open local 3D files, inspect models and save the
 - **Save locally:** PNG images and mesh exports in binary STL, OBJ, 3MF, STEP and IGES.
 - **Save and restore scenes:** VSB packages the scene and meshes; VSJ stores scene settings and references to model files.
 - **Check meshes for 3D printing:** topology checks, detailed intersection and volume analysis, issue highlights and optional FDM estimates.
+- **Analyze on a server:** a Node.js API reuses the same parsers and mesh checks in background workers, with bounded concurrency and cancellation.
 - **Embed in your own interface:** use the `StlViewer` API, or bind your own markup to the optional `mountViewstlApp` controller.
 
 ## Usage
@@ -64,12 +90,12 @@ Replace `/models/part.stl` with a model URL you serve. To open a local file inst
 
 ### npm and bundlers
 
-> **Release candidate:** `2.0.0-rc.1` is the first npm release of ViewSTL v2.00. Candidates use the `next` dist-tag; pin the version below for a repeatable installation.
+> **Release candidate:** `2.0.0-rc.3` adds the Node.js model-analysis API to ViewSTL v2.00. Candidates use the `next` dist-tag; pin the version below for a repeatable installation.
 
 Install the package in your application:
 
 ```sh
-npm install @omrips/viewstl@2.0.0-rc.1
+npm install @omrips/viewstl@2.0.0-rc.3
 ```
 
 Copy the **complete `node_modules/@omrips/viewstl/build/v2/` directory** to your application's static assets. For an application that serves `public/` at its root, use `public/viewstl-v2/`. Keep the worker, `chunks/`, `cad/` and notices together; repeat this copy when updating the package.
@@ -94,7 +120,7 @@ const viewer = new StlViewer(document.getElementById('viewer'), {
 
 Set `worker_url` to the URL where your application serves the copied worker, and replace `/models/part.stl` with your model URL. The bundler handles the viewer import; the static directory supplies its worker and optional parser assets. Creating a viewer requires a browser DOM and WebGL 2.
 
-The distribution includes TypeScript declarations and a CommonJS entry point. The static-assets setup above is verified with Vite 8.3.4 and Webpack 5.112.0. See [usage and packaging](https://unpkg.com/@omrips/viewstl@2.0.0-rc.1/docs/v2-usage.md) for worker factories, callbacks and more examples.
+The distribution includes TypeScript declarations and a CommonJS entry point. The static-assets setup above is verified with Vite 8.3.4 and Webpack 5.112.0. See [usage and packaging](https://unpkg.com/@omrips/viewstl@2.0.0-rc.3/docs/v2-usage.md) for worker factories, callbacks and more examples.
 
 ## Formats and saving
 
@@ -111,13 +137,15 @@ The distribution includes TypeScript declarations and a CommonJS entry point. Th
 
 STL, OBJ, 3MF, STEP and IGES export model geometry. **VSB and VSJ save the scene**, including its models, transforms and viewing settings. VSJ requires access to its referenced model files; VSB carries its mesh data inside the archive.
 
-STEP/IGES exports describe the loaded triangle mesh. They do not reconstruct original CAD solids, curves, feature history or assemblies. OBJ import does not load external materials or textures, and 3MF support does not cover every extension. See the [format and export details](https://unpkg.com/@omrips/viewstl@2.0.0-rc.1/docs/v2-usage.md#rendering-and-file-processing).
+STEP/IGES exports describe the loaded triangle mesh. They do not reconstruct original CAD solids, curves, feature history or assemblies. OBJ import does not load external materials or textures, and 3MF support does not cover every extension. See the [format and export details](https://unpkg.com/@omrips/viewstl@2.0.0-rc.3/docs/v2-usage.md#rendering-and-file-processing).
 
 ## Local files and URL imports
 
-Local file contents are processed on the user's device. Rendering, mesh checks, model exports and scene saving do not require an upload or a conversion service. Archive and CAD support load additional assets only when needed.
+In the browser, local file contents are processed on the user's device. Rendering, mesh checks, model exports and scene saving do not require an upload or a conversion service. Archive and CAD support load additional assets only when needed.
+
+The optional Node.js API processes files on the machine running Node. If your application accepts uploads for server analysis, those files leave the user's device. The package itself provides no upload endpoint and does not send model data anywhere.
 
-Direct URL imports require the remote server to allow browser access through CORS. A host application can configure its own streaming relay for other public URLs. **The relay is a separate server service**, not part of the plugin's JavaScript bundle. The preview website uses such a relay; URL imports pass through that server. See [URL import configuration](https://unpkg.com/@omrips/viewstl@2.0.0-rc.1/docs/v2-usage.md#optional-streaming-url-imports).
+Direct URL imports require the remote server to allow browser access through CORS. A host application can configure its own streaming relay for other public URLs. **The relay is a separate server service**, not part of the plugin's JavaScript bundle. The preview website uses such a relay; URL imports pass through that server. See [URL import configuration](https://unpkg.com/@omrips/viewstl@2.0.0-rc.3/docs/v2-usage.md#optional-streaming-url-imports).
 
 ## Existing users and previous versions
 
@@ -128,11 +156,11 @@ Direct URL imports require the remote server to allow browser access through COR
 | Source | Existing files in `src/` | `src/v2/` |
 | Browser script | `build/stl_viewer.min.js` | `build/v2/viewstl.min.js` |
 | Renderer | Three.js | Native WebGL 2 |
-| Documentation | [viewstl.com/plugin](https://www.viewstl.com/plugin/) | [Package usage and API notes](https://unpkg.com/@omrips/viewstl@2.0.0-rc.1/docs/v2-usage.md) |
+| Documentation | [viewstl.com/plugin](https://www.viewstl.com/plugin/) | [Package usage and API notes](https://unpkg.com/@omrips/viewstl@2.0.0-rc.3/docs/v2-usage.md) |
 
-The familiar `StlViewer` constructor and many public methods are retained. Integrations that access Three.js camera, scene, renderer or model internals need migration. v2 requires WebGL 2 and does not include the legacy WebGL 1 or Canvas fallback. See [API differences and migration notes](https://unpkg.com/@omrips/viewstl@2.0.0-rc.1/docs/v2-usage.md#existing-api-and-intentional-differences).
+The familiar `StlViewer` constructor and many public methods are retained. Integrations that access Three.js camera, scene, renderer or model internals need migration. v2 requires WebGL 2 and does not include the legacy WebGL 1 or Canvas fallback. See [API differences and migration notes](https://unpkg.com/@omrips/viewstl@2.0.0-rc.3/docs/v2-usage.md#existing-api-and-intentional-differences).
 
-Existing tags and release history are retained. The [legacy archive notes](https://unpkg.com/@omrips/viewstl@2.0.0-rc.1/legacy/README.md) also describe the separate local v1.14 snapshot and its provenance.
+Existing tags and release history are retained. The [legacy archive notes](https://unpkg.com/@omrips/viewstl@2.0.0-rc.3/legacy/README.md) also describe the separate local v1.14 snapshot and its provenance.
 
 The documentation link remains **https://www.viewstl.com/plugin/**. It currently documents the legacy plugin; v2 guidance is included in this package while the website documentation is prepared.
 
@@ -141,7 +169,7 @@ The documentation link remains **https://www.viewstl.com/plugin/**. It currently
 - A browser with WebGL 2 and module-worker support; WebAssembly is required for STEP/IGES import.
 - Model capacity depends on geometry complexity and available browser/GPU memory. Configured limits reject files that exceed the budget.
 - Print checks describe the loaded mesh. FDM results are estimates, and checks do not guarantee a successful print. Models are checked separately; assembly overlaps are not evaluated.
-- The preview has automated and desktop Chromium/Edge coverage. Firefox, Safari and physical mobile-device validation remain pending. See [verification and known limits](https://unpkg.com/@omrips/viewstl@2.0.0-rc.1/docs/v2-verification.md).
+- The preview has automated and desktop Chromium/Edge coverage. Firefox, Safari and physical mobile-device validation remain pending. See [verification and known limits](https://unpkg.com/@omrips/viewstl@2.0.0-rc.3/docs/v2-verification.md).
 
 ## Development
 
@@ -160,4 +188,4 @@ Open `http://127.0.0.1:8772/examples/v2/` for the local demo. The build writes t
 
 ## License
 
-ViewSTL is available under the [MIT license](https://unpkg.com/@omrips/viewstl@2.0.0-rc.1/LICENSE). Optional archive and CAD dependencies have their own licenses and notices; see [third-party notices](https://unpkg.com/@omrips/viewstl@2.0.0-rc.1/THIRD-PARTY-NOTICES.txt).
+ViewSTL is available under the [MIT license](https://unpkg.com/@omrips/viewstl@2.0.0-rc.3/LICENSE). Optional archive and CAD dependencies have their own licenses and notices; see [third-party notices](https://unpkg.com/@omrips/viewstl@2.0.0-rc.3/THIRD-PARTY-NOTICES.txt).

package/build/v2/README.md

@@ -9,3 +9,7 @@ The existing `../stl_viewer.min.js` and its companion files remain the
 legacy distribution. A v2 build must never overwrite those files.
 
 See [the compatibility requirements](../../docs/v2-compatibility.md).
+
+`node/` contains the separate server analysis entry points and worker, exported
+as `@omrips/viewstl/node`. These resolve `cad/` inside the npm package; Node users
+do not need to copy assets to a website.