three-slicer-viewer 0.3.5 → 0.4.0

package/COMPONENTS.md

@@ -1,7 +1,8 @@
 # three-slicer-viewer/components — the settings form
 
-(Published as `three-slicer-viewer/components`, MIT. `three-slicer/components` is the same component with upstream's
-schema, tab tree and toggle rules plugged in; everything below applies to both.)
+(Published as `three-slicer-viewer/components`, MIT. Upstream's labels, tab tree and toggle rules come from
+`three-slicer` through the `schema`, `uiTree` and `toggle` props, as below; without them every field is labelled by
+its key and nothing is disabled.)
 
 Reusable React components for the browser slicer. Props-driven — no global state, no React context, no router coupling (proven standalone by the tarball consumer gate `packages/pack_check.sh`).
 
@@ -12,16 +13,20 @@ An OrcaSlicer-style settings form generated from `three-slicer/data` (schema + U
 The tab set follows the printer profile's technology: a settings map whose `printer_technology` says SLA swaps the FFF tabs for the SLA ones (print/material/printer builders carry the technology in their upstream builder name, which is what the filter reads). No prop needed — change the profile in the shared settings map and the panel follows.
 
 ```bash
-npm i three-slicer react react-dom     # react is an OPTIONAL peer — npm does not install it for you
+npm i three-slicer three-slicer-viewer react react-dom   # same version for the two; react is an OPTIONAL peer — npm does not install it for you
 ```
 
 ```jsx
 import { useState } from 'react'
-import SettingsPanel from 'three-slicer/components'
+import SettingsPanel from 'three-slicer-viewer/components'
+import { schema, uiTree } from 'three-slicer/data'                 // upstream's labels, tooltips and tab tree (AGPL)
+import { makeCfg, disabledKeys } from 'three-slicer/toggle'         // the evaluator bound to upstream's rules (AGPL)
+
+const toggle = { makeCfg, disabledKeys }
 
 function App() {
   const [settings, setSettings] = useState({})   // sparse map: edited keys only; missing = schema default
-  return <SettingsPanel settings={settings} setSettings={setSettings} />
+  return <SettingsPanel schema={schema} uiTree={uiTree} toggle={toggle} settings={settings} setSettings={setSettings} />
 }
 ```
 
@@ -36,11 +41,11 @@ Props:
 | `customWidgets` | `{ [schemaKey]: Component }` (optional) | Replace schema-driven widgets per key (e.g. `{ printable_area: MyBedEditor }`) |
 | `only` | `{ builder, page? }` (optional) | Pins the panel to one builder/page and drops the search/page/mode chrome — how `<Viewport/>`'s `motionPanel` slot is meant to be filled |
 
-The same `settings` object feeds `deriveKernelParams()` in `three-slicer` and the `<Viewport/>` in `three-slicer/viewer` — one state connects all three.
+The same `settings` object feeds `deriveKernelParams()` in `three-slicer` and `three-slicer-viewer`'s `<Viewport/>` — one state connects all three.
 
 Ships transpiled ESM (`dist/`); react is an optional peer dependency. The panel arrives fully styled: its stylesheet is inlined into the bundle and injected into a Shadow DOM root, so host CSS neither styles it nor collides with it.
 
-The 3D viewport lives in its own package: `three-slicer/viewer`.
+The 3D viewport is the package's main entry, `three-slicer-viewer` ([VIEWER.md](VIEWER.md)).
 
 ## License
 

package/README.md

@@ -6,7 +6,7 @@ commercial products.
 
 This is [`three-slicer`](https://www.npmjs.com/package/three-slicer) with the kernel taken out. It displays and
 exports; it does not slice. Slicing is plugged in through two props — `slicer` (a hook driving a kernel) and
-`catalog` (vendor presets) — which `three-slicer/viewer` supplies. Install `three-slicer` for that, and note that
+`catalog` (vendor presets) — which `three-slicer` supplies (below). Install `three-slicer` for that, and note that
 doing so puts your application under AGPL.
 
 Developed in the [`Three_Slicer`](https://github.com/kimgh06/Three_Slicer) monorepo (`viewer-package/`), where it
@@ -41,7 +41,7 @@ const slicer = (deps) => useSlicer({ ...deps, makeWorker: makeSlicerWorker })
 import SettingsPanel from 'three-slicer-viewer/components'
 
 // Bare: fields labelled by key, nothing disabled. Pass `schema`, `uiTree` and `toggle` for labels, tabs and
-// enable/disable rules — three-slicer/components does that with OrcaSlicer's data; a host may pass its own.
+// enable/disable rules — three-slicer/data and /toggle carry OrcaSlicer's; a host may pass its own.
 <SettingsPanel settings={settings} setSettings={setSettings} />
 ```
 

package/VIEWER.md

@@ -1,26 +1,30 @@
 # three-slicer-viewer — the viewer
 
-(Published as `three-slicer-viewer`, MIT. `three-slicer/viewer` is the same component with the WASM kernel and the
-vendor catalog plugged in; everything below applies to both.)
+(Published as `three-slicer-viewer`, MIT. Slicing and the vendor presets come from `three-slicer` through the
+`slicer` and `catalog` props, as below; without them the viewer loads, displays and exports, but never slices.)
 
 3D slicer viewer as a React component: three.js viewport (orbit/transform gizmos), model import (STL/OBJ/3MF/AMF/PLY + pluggable formats such as STEP, multi-object, drag & drop), Web Worker slicing via `three-slicer`, support and material painting, per-extruder filament presets, multi-plate, and a GPU-instanced volumetric toolpath preview ported from OrcaSlicer's libvgcode (millions of segments in a single draw path, per-feature colors, layer range slider, G-code export).
 
 ![The Prepare tab — drag-and-drop viewport with the printer, filament and process cards in the right sidebar](../../slice-sidebar.png)
 
 ```bash
-npm i three-slicer react react-dom three     # the three are optional peers; the viewer needs all of them
+npm i three-slicer three-slicer-viewer react react-dom three   # same version for the two; the last three are optional peers the viewer needs
 ```
 
 ```jsx
 import { useState } from 'react'
-import Viewport from 'three-slicer/viewer'
+import Viewport, { useSlicer } from 'three-slicer-viewer'
+import { makeSlicerWorker } from 'three-slicer/client'     // the WASM kernel's worker (AGPL)
+import { bundledCatalog } from 'three-slicer/settings'     // OrcaSlicer's vendor presets (AGPL)
+
+const slicer = (deps) => useSlicer({ ...deps, makeWorker: makeSlicerWorker })   // module-level: it is a hook
 
 function App() {
   const [settings, setSettings] = useState({})   // OrcaSlicer schema keys; sparse — defaults fill the rest
   // The container matters — see Layout below.
   return (
     <div style={{ position: 'relative', width: '100%', height: '100vh' }}>
-      <Viewport settings={settings} setSettings={setSettings} />
+      <Viewport slicer={slicer} catalog={bundledCatalog} settings={settings} setSettings={setSettings} />
     </div>
   )
 }
@@ -37,7 +41,7 @@ the initial containing block instead, which usually looks like the viewer coveri
 
 There is no width or height prop: the component always fills that container, and resizes with it.
 
-Slice parameters are derived from `settings` via `three-slicer`'s schema mapping — pair it with `three-slicer/components`' `<SettingsPanel/>` sharing the same state for a full slicer UI.
+Slice parameters are derived from `settings` via `three-slicer`'s schema mapping — pair it with `three-slicer-viewer/components`' `<SettingsPanel/>` ([COMPONENTS.md](COMPONENTS.md)) sharing the same state for a full slicer UI.
 
 A `.3mf` written by a slicer (OrcaSlicer/BambuStudio save, MakerWorld download) imports as a **project**: plate layout, project settings, and support/material painting are restored, not just the meshes. Where a facet carries both paint kinds, material paint wins and the dropped support paint is reported.
 
@@ -47,9 +51,9 @@ next to the material picker) takes a **function** `(settings, setSettings) => Re
 card binds each extruder's per-extruder values.
 
 Subpath exports for custom UIs (framework-free, no React):
-- `three-slicer/viewer/toolpath` — GPU toolpath renderer (`buildSegmentData`, `makeToolpath`, view-type colorers)
-- `three-slicer/viewer/loaders` — model loaders returning unified triangle soup
-- `three-slicer/viewer/gcode` — `parseGcode(text)`, G-code back into the layer stream the renderer consumes
+- `three-slicer-viewer/toolpath` — GPU toolpath renderer (`buildSegmentData`, `makeToolpath`, view-type colorers)
+- `three-slicer-viewer/loaders` — model loaders returning unified triangle soup
+- `three-slicer-viewer/gcode` — `parseGcode(text)`, G-code back into the layer stream the renderer consumes
 
 ## Embedding it without the panels
 
@@ -233,7 +237,7 @@ Two limits to expect while using it:
 - Painting a region onto a second extruder only takes effect with **support turned off**. The painted multi-material path emits no support, so a support-enabled slice deliberately stays on the single-material path (where painted support keeps working as before).
 - On a machine with two or more extruders, a support *blocker* paint and an *Extruder 2* paint are the same mark and cannot be told apart.
 
-If you consume `three-slicer/viewer/toolpath` directly, note that the stride-8 role field `paths[k+3]` now carries the printing extruder alongside the role as `role + tool * 16`. Mask it — `& 15` for the role, `>>> 4` for the tool. Streams produced before this encoding are entirely below 16 and decode to their own role with tool 0, so older data still reads correctly.
+If you consume `three-slicer-viewer/toolpath` directly, note that the stride-8 role field `paths[k+3]` now carries the printing extruder alongside the role as `role + tool * 16`. Mask it — `& 15` for the role, `>>> 4` for the tool. Streams produced before this encoding are entirely below 16 and decode to their own role with tool 0, so older data still reads correctly.
 
 ## Turning behaviour off
 
@@ -336,7 +340,7 @@ The component owns its scene, and the props are the whole interface — there is
 - Everything else the component owns — camera, selection, plate count, paint state — is reported through `onEvent`
   and settable only by the user.
 
-If you need programmatic control over the scene, build on the subpath exports (`three-slicer/viewer/toolpath`,
+If you need programmatic control over the scene, build on the subpath exports (`three-slicer-viewer/toolpath`,
 `/loaders`, `/gcode`) and `three-slicer/client` rather than on `<Viewport/>`.
 
 ## Multithreaded slicing (automatic)

package/dist/index.js

@@ -4864,7 +4864,7 @@ function Dp({ error: e }) {
   return /* @__PURE__ */ i.createElement("div", { className: "slice-err side-warn", "data-testid": "slice-err" }, t, r && /* @__PURE__ */ i.createElement("pre", { className: "slice-err-detail" }, r));
 }
 function Gp() {
-  return "0.3.5";
+  return "0.4.0";
 }
 const Br = Gp();
 function Up({ on: e = !0 }) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "three-slicer-viewer",
-  "version": "0.3.5",
+  "version": "0.4.0",
   "description": "The three-slicer viewer without the slicer — model loading, G-code parsing, GPU toolpath rendering and the settings transforms, under MIT. Plug a slicer in through the `slicer` prop.",
   "license": "MIT",
   "type": "module",

package/types/components.d.ts

@@ -1,12 +1,12 @@
-// three-slicer/components
+// three-slicer-viewer/components
 import type * as React from 'react'
 import type { SlicerSettings } from './settings-keys.d.ts'
 
 export interface SettingsPanelProps {
   /**
    * The config schema to render from. Defaults to this package's reduced schema — types, defaults, enum values,
-   * layout flags and units, but no label or tooltip, so a field is labelled by its key. `three-slicer/components`
-   * passes the full schema; a host may pass its own (a translation, its own vocabulary).
+   * layout flags and units, but no label or tooltip, so a field is labelled by its key. Pass
+   * three-slicer/data's full schema for upstream's labels; a host may pass its own (a translation, its own vocabulary).
    */
   schema?: Record<string, Record<string, unknown>>
   /** The tab/page/group tree. Defaults to one flat page per builder over this package's ui-tree keys. */

package/types/gcode.d.ts

@@ -1,5 +1,5 @@
-// three-slicer/viewer/gcode — G-code text -> kernel-shaped layer stream (renderable without slicing).
-// Feed the returned layers straight into buildSegmentData (three-slicer/viewer/toolpath).
+// three-slicer-viewer/gcode — G-code text -> kernel-shaped layer stream (renderable without slicing).
+// Feed the returned layers straight into buildSegmentData (three-slicer-viewer/toolpath).
 
 export interface GcodeLayer {
   z: number

package/types/toolpath.d.ts

@@ -1,5 +1,4 @@
 // three-slicer-viewer — kernel layers -> GPU-instanced toolpath.
-// Also published as three-slicer/viewer/toolpath, which re-exports this package.
 // Does not import three: makeToolpath takes the THREE namespace as an argument (guaranteeing a single instance).
 
 /** The 24 triangle indices of the 8-vertex diamond cross-section (from SegmentTemplate.cpp:18) */

package/types/viewer.d.ts

@@ -1,4 +1,4 @@
-// three-slicer/viewer
+// three-slicer-viewer
 import type * as React from 'react'
 import type { SlicerSettings } from './settings-keys.d.ts'
 import type { ProcessPresetsApi, FilamentPresetsApi } from './settings.d.ts'
@@ -114,8 +114,8 @@ export interface ViewportProps {
    */
   slicer?: (deps: Record<string, unknown>) => SlicerHandle
   /**
-   * The vendor preset catalog. This package ships none — nothing passed means empty pickers. `three-slicer/viewer`
-   * passes its bundled OrcaSlicer extraction; a host with its own fleet passes its own (a partial object is
+   * The vendor preset catalog. This package ships none — nothing passed means empty pickers. `three-slicer/settings`'
+   * `bundledCatalog` is the OrcaSlicer extraction; a host with its own fleet passes its own (a partial object is
    * merged over the empty catalog).
    */
   catalog?: Catalog | null
@@ -254,5 +254,5 @@ export function resolveCatalog(catalog?: Partial<Catalog> | null): Catalog
 export function useNoopSlicer(): SlicerHandle
 
 /** The slicing hook, unbound. `deps.makeWorker` must return a Worker speaking this package's slice protocol —
- *  three-slicer/viewer supplies its WASM kernel worker and re-exports the bound hook. */
+ *  three-slicer/client's makeSlicerWorker is the WASM kernel's. */
 export function useSlicer(deps: Record<string, unknown> & { makeWorker: () => Worker }): SlicerHandle